TheAlgorithms / TheAlgorithms/Python
Suggestion: adopt a documentation format for docstring
Nessuno ha ancora preso questa issue.
- Lingua principale
- Python
- Stelle
- 225k
- Fork
- 51.1k
- Merge medio
- 1g 23h
- PR unite (30g)
- 156
Descrizione
As the number of algorithms are increasing, it might make sense to adopt a single documentation format for docstrings. Following are existing currently:
- Google Docstring: https://google.github.io/styleguide/pyguide.html#s3.8-comments-and-docstrings
- Numpydoc: https://numpydoc.readthedocs.io/en/latest/format.html
- Sphinx: https://sphinx-rtd-tutorial.readthedocs.io/en/latest/docstrings.html
There are editor extensions which help in generating the docstring based on the chosen format like:
The doctest will come under the examples section for each of the above format.
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia confrontando i formati Google Docstring, Numpydoc e Sphinx collegati nell’issue, incluso il modo in cui ciascuno gestisce gli esempi doctest. Esamina la discussione per determinare se il progetto ha scelto un formato. Il lavoro è completato quando esistono un formato di documentazione concordato e un modo definito per applicarlo ai docstring degli algoritmi.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- python
- Ambito
- documentation
- Tipo di issue
- Funzionalità
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Stato di attività
- Attiva
- Chiarezza
- Da chiarire
- Idoneità per principianti
- 25/100