docstring

47calore

7risposta

Esistono alternative reali a reStructuredText per la documentazione di Python?

Sto avviando un progetto Python open source a breve e sto cercando di decidere in anticipo come scrivere le mie docstring. La risposta ovvia sarebbe utilizzare reStructuredText e Sphinx con autodoc, p

29calore

3risposta

Come faccio a fare riferimento a un parametro della funzione Python documentato usando il markup Sphinx?

Vorrei fare riferimento a un parametro di funzione precedentemente documentato altrove in una docstring Python. Si consideri il seguente (per ammissione del tutto artificiale) Esempio: def foo(bar):

5calore

1risposta

Modo canonico in Python per aggiungere o recuperare le meta informazioni da/per docstring?

Vorrei aggiungere alcune meta informazioni alle docstring dei miei moduli Python, come autore, email, versione. C'è un modo canonico per farlo? Ho cercato un po ', ma non ho trovato nulla con un'autor

21calore

3risposta

Multiline clojure docstrings

Ho notato che le letture multilinea Clojure sembrano essere formattate manualmente nella maggior parte dei casi, comprese quelle in clojure.core. Esempio da https://github.com/clojure/clojure/blob/mas

10calore

4risposta

Eredita una docstring della classe genitore come attributo __doc__

C'è una domanda su Inherit docstrings in Python class inheritance, ma le risposte riguardano le docstring del metodo. La mia domanda è come ereditare una docstring di una classe genitore come attribut

22calore

2risposta

Documentazione Clojure per librerie/spazi dei nomi

Come aggiungere docstring e/o commenti alle librerie Clojure/namespace nel loro insieme, cioè non solo a funzioni specifiche all'interno del namespace? Ho notato che la fonte del clojure utilizza (com

26calore

4risposta

Come mettere una variabile in Python docstring

Così sto cercando di creare un docstring "dinamica", che è qualcosa di simile: ANIMAL_TYPES = ["mammals", "reptiles", "other"] def func(animalType): """ This is a sample function. @param anim

9calore

1risposta

Che significato hanno questi formati nella docstring di twisted?

Nel codice sorgente di twisted, molte docstrings contengono formati come questo: L {xxx} o C {xxx} o una riga inizia con un '@', qual è il loro significato? per esempio, in contorto/internet/interface

9calore

1risposta

Come specificare docstring per __init__ nell'estensione Python

Forse una domanda stupida: come si può specificare docstring per funzioni speciali come __init__ quando si scrive un'estensione C? Per i metodi ordinari, la tabella dei metodi dispone di docstring. La

5calore

2risposta

È possibile sublimare le stringhe di Python in colori diversi da stringhe a linea singola?

Mi piacerebbe distinguere tra le stringhe Python e le stringhe single-line in Sublime Text 2. Guardando la definizione del linguaggio Python, posso vedere questo, insieme a una definizione corrisponde