Stop repeating input/output type info in docstrings
Offen
Dieses Issue hat noch niemand übernommen.
cuda.core
documentation
P1
- Vorherrschende Sprache
- Cython
- Sterne
- 3.4k
- Forks
- 329
- Ø Merge
- 1 T. 23 Std.
- Gemergte PRs (30 T.)
- 116
Beschreibung
I think Sphinx is able to figure out the types and keep them in the document by inspecting the typing info, which going forward should be our source of truth (https://github.com/NVIDIA/cuda-python/issues/312#issue-2746694448). We should not repeat ourselves.
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Es wird keine Datei und kein Test genannt. Lies zunächst die von diesem Issue abgedeckten Docstrings und Typdefinitionen und prüfe anschließend die generierte Sphinx-Dokumentation; abgeschlossen ist die Arbeit, wenn redundante Eingabe-/Ausgabetypdeklarationen entfernt sind, während die Typen in der gerenderten Dokumentation weiterhin vorhanden sind.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- python
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Muss geklärt werden
- Anfängerfreundlichkeit
- 35/100