NVIDIA / NVIDIA/cuda-python

Stop repeating input/output type info in docstrings

Aperta
#454 2 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

cuda.core documentation P1
Lingua principale
Cython
Stelle
3.4k
Fork
329
Merge medio
1g 23h
PR unite (30g)
116

Descrizione

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.

Guida per i contributori

Apri la guida per i contributori

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.

Direzione di ricerca

Non viene indicato alcun file né test. Inizia leggendo i docstring e le definizioni dei tipi interessati da questo issue, quindi controlla la documentazione Sphinx generata; il lavoro è concluso quando le dichiarazioni ridondanti dei tipi di input/output sono rimosse, mentre i tipi rimangono presenti nella documentazione renderizzata.

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

Valutazione

Stack tecnologico
python
Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
3/5
Tempo stimato
1-2 giorni
Stato di attività
Ferma
Chiarezza
Da chiarire
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.