Resultados da pesquisa a pedido "docstring"
Qual é a vantagem de ter literais de várias linhas e linhas únicas em python?
Eu sei que as strings de aspas triplas são usadas como docstrings, mas existe uma necessidade real de ter dois literais de string?Existe algum caso de uso qu...
As docstrings e comentários do Python são armazenados na memória quando um módulo é carregado?
As docstrings e comentários do Python são armazenados na memória quando um módulo é carregado?Eu me perguntei se isso é verdade, porque normalmente eu docume...
Por que a documentação do python é interpretada de maneira diferente do comentário
Digamos, eu tenho uma função como esta: def myFunc(): # useful function to calculate stuffIsso produzirá um erro de recuo, a menos que eu adicionepass: def myFunc(): # useful function to calculate stuff passNo entanto, se eu substituir um ...
Mais de 1 documentação para um único módulo / função, etc.?
Estou usando python 3.1. É possível criar mais de uma docstring para um único módulo ou função? Estou criando um programa e pretendo ter vários documentos com uma categoria para cada um. Pretendo dar a outras pessoas o programa para que elas ...
Substituindo docstrings python [fechado]
Eu escrevi umepytext [http://epydoc.sourceforge.net/epytext.html]paradescansar [http://docutils.sourceforge.net/docs/user/rst/quickref.html]conversor de marcação e agora quero converter todos os documentos em toda a minha biblioteca do formato ...
Como parar o PyCharm de preencher documentos?
Se eu adicionar uma docstring a um método usando aspas triplas, assim que digitar um espaço após as aspas triplas, o PyCharm preencherá a docstring com os parâmetros que o método utiliza e com um valor de retorno, como: def fill_blank(self, ...
Gerar automaticamente a documentação do GitHub Wiki a partir de Python Docstrings
O título diz tudo. O que eu imagino é ter docstrings para todos os meus módulos, classes e funções e, de alguma forma, navegar no documento via github (wiki?). Além disso, o documento deve estar sincronizado com o código mais recente, o ...
Pycharm: Auto gerar `: digite param:` campo no docstring
Quando crio uma função com parâmetros, o PyCharm oferece-me para criar a docstring com:param param_name: campo, o que é muito bom. Mas eu também preciso adicionar o:type param_name:. Então a partir disso: def foo(bar, xyz): return bar + xyzCom ...
print (__ doc__) no script Python 3
Não consigo descobrir o que faz oprint(__doc__) fazer no início de um script, comoneste exemplo do ...
Como documentar: rtype: para uma função que retorna vários tipos de dados possíveis? [duplicado
Esta pergunta já tem uma resposta aqui: Como especificar vários tipos de retorno usando dicas de tipo [/questions/33945261/how-to-specify-multiple-return-types-using-type-hints] 2 respostas Em uma documentação em Python, como se deve documentar ...