python-trio/trio

Some functions and properties in the documentation have no docstring

Open

#3221 aperta il 10 mar 2025

Vedi su GitHub
 (10 commenti) (0 reazioni) (0 assegnatari)Python (310 fork)batch import
docsgood first issue

Metriche repository

Star
 (5479 star)
Metriche merge PR
 (Merge medio 14h 5m) (6 PR mergiate in 30 g)

Descrizione

The following things lack documentation in Trio's documentation:

  • trio.CancelScope.relative_deadline
  • trio.MemorySendChannel
  • trio.MemoryReceiveChannel
  • trio.MemoryChannelStatistics
  • trio.SocketStream.aclose
  • trio.SocketStream.receive_some
  • trio.SocketStream.send_all
  • trio.SocketStream.send_eof
  • trio.SocketStream.wait_send_all_might_not_block
  • trio._subprocess.HasFileno.fileno
  • trio.lowlevel.ParkingLot.broken_by

These should either have documentation or not show up (e.g. the SocketStream attributes seem unnecessary, they're only in the docs because of a :undoc-members:).

At https://trio.readthedocs.io/en/latest/reference-core.html#trio.CancelScope.relative_deadline, there is no definition of the semantics of relative_deadline. Looks like it was added in #3010.

Guida contributor

Direzione di ricerca
Per ogni elemento non selezionato nell'elenco, individua il codice sorgente e aggiungi una docstring descrittiva. Per i metodi SocketStream, considera se dovrebbero essere nascosti dalla documentazione poiché appaiono a causa di :undoc members:.
Tech stack
python
Dominio
api
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Python
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
70