python-trio/trio

Some functions and properties in the documentation have no docstring

Open

#3.221 aberto em 10 de mar. de 2025

Ver no GitHub
 (10 comments) (0 reactions) (0 assignees)Python (310 forks)batch import
docsgood first issue

Métricas do repositório

Stars
 (5.479 stars)
Métricas de merge de PR
 (Mesclagem média 14h 5m) (6 fundiu PRs em 30d)

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.

Guia do colaborador

Direção de pesquisa
Para cada item não marcado na lista, localize o código fonte e adicione uma docstring descritiva. Para os métodos SocketStream, considere se eles devem ser ocultados da documentação, pois aparecem devido a :undoc members:.
Pilha de tecnologia
python
Domain
api
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Python
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
70