TheAlgorithms / TheAlgorithms/Python

Suggestion: adopt a documentation format for docstring

Offen
#6,252 12 Kommentare 3 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

awaiting reviews
Vorherrschende Sprache
Python
Sterne
225k
Forks
51.1k
Ø Merge
1 T. 23 Std.
Gemergte PRs (30 T.)
156

Beschreibung

As the number of algorithms are increasing, it might make sense to adopt a single documentation format for docstrings. Following are existing currently:

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.

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne damit, die im Issue verlinkten Formate Google Docstring, Numpydoc und Sphinx zu vergleichen, einschließlich des Umgangs mit doctest-Beispielen. Lies die Diskussion, um festzustellen, ob das Projekt ein Format ausgewählt hat. Als abgeschlossen gilt die Aufgabe, wenn ein vereinbartes Dokumentationsformat und eine festgelegte Methode zu dessen Anwendung auf Algorithmus-Docstrings vorhanden sind.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
python
Bereich
documentation
Issue-Typ
Feature
Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Aktivitätsstatus
Aktiv
Klarheit
Muss geklärt werden
Anfängerfreundlichkeit
25/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.