Sphinx: Improve doc strings

Aperta
#29 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
55/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Ferma
Stack tecnologico
python
Ambito
documentation

Direzione di ricerca

Start with the docstring in randomfiletree/core.py at lines 114-134 and compare it with the rendered Sphinx output linked in the issue. Check why the arguments are not all recognized, and consider the work complete when the generated HTML documents every argument consistently with the original docstring.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

documentation good first issue hacktoberfest

I'm not a Sphinx fan so I'm not able to give you an advice how to solve this.

But please see that this HTML output
https://randomfiletree.readthedocs.io/en/latest/core.html#randomfiletree.core.iterative_gaussian_tree

doesn't fit to the original docstring
https://github.com/klieret/RandomFileTree/blob/4e3df78b642f46a7148661362d8e28935c72867f/randomfiletree/core.py#L114-L134

Not all arguments are recognized as arguments.

Lingua principale
Python
Stelle
34
Fork
8
Nessuna PR unita negli ultimi 30g

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di klieret/RandomFileTree

Tutte le issue di klieret/RandomFileTree

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.