Buffered reader documentation for timeout 0
Dieses Issue hat noch niemand übernommen.
Bewertung
- Schwierigkeit
- 2/5
- Geschätzter Aufwand
- 1-3 Stunden
- Anfängerfreundlichkeit
- 35/100
- Issue-Typ
- Dokumentation
- Klarheit
- Größtenteils klar
- Aktivitätsstatus
- Veraltet
- Tech-Stack
- python
- Bereich
- documentation
Rechercherichtung
Beginne damit, die Implementierung von BufferedReader.get_message und ihren vorhandenen Docstring zu lesen, und prüfe anschließend, wie SimpleQueue einen Timeout von 0 behandelt. Kläre, welche Dokumentationsänderung vorgesehen ist – Hinweise zu einem positiven Timeout, ein Mindest-Timeout oder ein nicht spezifiziertes Verhalten bei einem Timeout von 0 – und aktualisiere die Dokumentation entsprechend.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Beschreibung
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
- Vorherrschende Sprache
- Python
- Sterne
- 1.6k
- Forks
- 697
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Beitragsleitfaden
Erste Schritte
- Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
- Forken Sie das Repository und arbeiten Sie in einem Branch.
- Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.
Mehr aus hardbyte/python-can
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 88/100
hardbyte/python-can#2103 ·
-
bug
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 78/100
hardbyte/python-can#2077 · 1 Kommentar · 1 Reaktion ·
-
bug
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 68/100
hardbyte/python-can#1922 · 1 Reaktion ·
-
enhancement
Schwierigkeit 5/5 Über eine Woche Anfängerfreundlichkeit 30/100
hardbyte/python-can#2102 ·
-
bug
Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 68/100
hardbyte/python-can#2092 ·
Alle Issues in hardbyte/python-can
Ähnliche Issues
-
bug
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 75/100
stephrobert/dsoxlab#238 ·
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 75/100
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 75/100
sublimehq/package_control#1780 ·
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 65/100
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 70/100
nwg-piotr/nwg-displays#145 ·