python-trio/trio

Some functions and properties in the documentation have no docstring

Open

#3 221 ouverte le 10 mars 2025

Voir sur GitHub
 (10 commentaires) (0 réactions) (0 assignés)Python (310 forks)batch import
docsgood first issue

Métriques du dépôt

Stars
 (5 479 stars)
Métriques de merge PR
 (Merge moyen 14h 5m) (6 PRs mergées en 30 j)

Description

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.

Guide contributeur

Direction de recherche
Pour chaque élément non coché de la liste, localisez le code source et ajoutez une docstring descriptive. Pour les méthodes SocketStream, déterminez si elles doivent être masquées de la documentation car elles apparaissent en raison de :undoc members:.
Stack technique
python
Domaine
api
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Python
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
70