Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Buffered reader documentation for timeout 0

Aperta
#1,919 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

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

Direzione di ricerca

Inizia leggendo l’implementazione di BufferedReader.get_message e la relativa docstring esistente, quindi esamina come SimpleQueue gestisce un timeout pari a 0. Determina quale modifica alla documentazione è prevista —indicazioni su un timeout positivo, un timeout minimo o un comportamento non specificato per un timeout pari a 0— e aggiorna la documentazione di conseguenza.

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

Descrizione

Some guys asked me what would happen if one is using the BufferedReader.get_message function with a timeout of 0. I checked the implementation and it looks like as this library relys on the Python SimpleQueue this is depending on the specific system. See here:
https://bugs.python.org/issue28982

I would like to suggest some changes at least to the documentation. I have the following proposals while not all of them might be done:

  • Add information to the docstring that the timeout should always be a positive number (and maybe at least 10ms)
  • Add a check for the timeout to be at least 10ms (or even 1ms)
  • Add some information to the docstring that this relys on SimpleQueue and handling of a timeout of 0 or less is not specified

Please tell me your thoughts

Lingua principale
Python
Stelle
1.6k
Fork
697
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

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.

Altre issue di hardbyte/python-can

Tutte le issue di hardbyte/python-can

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.