NVIDIA / NVIDIA/cuda-python

[DOC]: C API doc strings don't always make sense with python bindings

Aperta
#721 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

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

Descrizione

Is this a duplicate?
Is this for new documentation, or an update to existing docs?

Update

Describe the incorrect/future/missing documentation
Image cuda-bindings turns some c api arguments into returns, and yet it still reuses C API doc strings that don't make sense. See e.g. on enclosed screenshot, `from and to may both be NULL`, but user doesn't control `from` and `to` so user cannot set them to NULL. There's also broken formatting where things that should not be italicized are italicized. The doc should be something like "if numEdges is 0, `to` and `from` are returned as empty lists, and the function only returns the number of edges in `numEdges`. Otherwise, `to` and `from` will have `numEdges` entries" NULL also doesn't make sense in python context.
If this is a correction, please provide a link to the incorrect documentation. If this is a new documentation request, please link to where you have looked.

No response

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

Inizia individuando la documentazione rivolta a Python che riutilizza le stringhe della C API mostrate nello screenshot, quindi confronta le descrizioni dei parametri e dei valori restituiti con il comportamento del binding. Il lavoro è completato quando la documentazione interessata descrive le liste restituite e i valori Python anziché argomenti C controllati dall’utente o NULL, con la formattazione corretta.

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
Abbastanza chiara
Idoneità per principianti
45/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.