docstring

6calore

1risposta

Qual è l'uso del modello docstring di PyCharm? Come lo uso in modo efficace?

PyCharm, l'IDE Python genera un modello per docstring mentre inizio a digitare la docstring. Questo è il modello generato per una semplice funzione. def add_them(x, y): """ :param x: :

9calore

1risposta

Docstrings quando non viene restituito nulla

Che cos'è la convenzione docstring quando una funzione non restituisce nulla? Ad esempio: def f(x): """Prints the element given as input Args: x: any element Returns: """

15calore

3risposta

descrizione multilinea di una descrizione dei parametri in python docstring

Quindi, reStructuredText è the recommended way per Python codice documentazione, se si tenta già abbastanza difficile, si può find in the sphinx documentation come normalizzare la documentazione firma

9calore

3risposta

Come docstring in python per più lingue

Voglio creare un nuovo modulo per me stesso ma voglio anche che alcuni colleghi siano in grado di usarlo. Ho iniziato a scrivere le mie docstring in inglese, ma poi ho capito che renderà il modulo inu

5calore

2risposta

Indicare i campi generati dal codice PyCharm della classe

Come caso minimo, ho una classe Example che funziona come una capacità astratta per una gamma di altre classi. class Example(object): def __init__(self, **kwargs): for key, value in kwargs.

6calore

2risposta

Come documentare: rtype: per una funzione che restituisce più tipi di dati possibili?

In una documentazione di Python come si dovrebbe documentare :rtype: per una funzione che può restituire più tipi di dati possibili? Ad esempio, se una funzione può restituire defaultdict OR dict O li

15calore

1risposta

Come esprimere più tipi per un singolo parametro o un valore di ritorno in docstrings elaborati da Sphinx?

A volte una funzione in Python può accettare un argomento di un tipo flessibile. Oppure può restituire un valore di un tipo flessibile. Ora non riesco a ricordare un buon esempio di tale funzione in q

8calore

1risposta

funzione di fare avere i puntini di sospensione per gli argomenti in aiuto la funzione()

Se si digita help(vars), viene prodotto il seguente: vars(...) vars([object]) -> dictionary Without arguments, equivalent to locals(). With an argument, equivalent to object.__dict__.

5calore

1risposta

PyCharm docstrings che collegano alle classi

IntelliJ IDEA consente il collegamento ad altri metodi nei commenti del documento Java. Questo mi consente di spostare il cursore su un simbolo e saltare alla definizione usando una scorciatoia da tas

21calore

2risposta

stampa (__ doc__) in script Python 3

Non riesco a capire cosa fa il print(__doc__) all'inizio di uno script, ad esempio in this Scikit example. ho cercato per Python docstring in google, e sembra __doc__ è utile fornire alcuni documenti,