Buffered reader documentation for timeout 0
Personne n'a encore pris cette issue.
Évaluation
- Difficulté
- 2/5
- Temps estimé
- 1-3 heures
- Accessibilité débutants
- 35/100
- Type d'issue
- Documentation
- Clarté
- Plutôt claire
- Activité
- À l'abandon
- Stack technique
- python
- Domaine
- documentation
Piste de recherche
Commencez par lire l’implémentation de BufferedReader.get_message et sa docstring existante, puis examinez la façon dont SimpleQueue gère un timeout de 0. Déterminez quelle modification de la documentation est prévue —des indications sur un timeout positif, un timeout minimal ou un comportement non spécifié pour un timeout de 0— et mettez la documentation à jour en conséquence.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Description
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
- Langage dominant
- Python
- Étoiles
- 1.6k
- Forks
- 697
- Métriques de merge des PR
- Aucune PR mergée en 30 j
Guide de contribution
Ouvrir le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Autres issues de hardbyte/python-can
-
Difficulté 2/5 1-3 heures Accessibilité débutants 88/100
hardbyte/python-can#2103 ·
-
bug
Difficulté 1/5 Moins d'une heure Accessibilité débutants 78/100
hardbyte/python-can#2077 · 1 commentaire · 1 réaction ·
-
bug
Difficulté 1/5 Moins d'une heure Accessibilité débutants 68/100
hardbyte/python-can#1922 · 1 réaction ·
-
enhancement
Difficulté 5/5 Plus d'une semaine Accessibilité débutants 30/100
hardbyte/python-can#2102 ·
-
bug
Difficulté 3/5 1-2 jours Accessibilité débutants 68/100
hardbyte/python-can#2092 ·
Toutes les issues de hardbyte/python-can
Issues similaires
-
bug
Difficulté 2/5 1-3 heures Accessibilité débutants 75/100
stephrobert/dsoxlab#238 ·
-
Difficulté 2/5 1-3 heures Accessibilité débutants 75/100
-
Difficulté 2/5 1-3 heures Accessibilité débutants 75/100
sublimehq/package_control#1780 ·
-
Difficulté 2/5 1-3 heures Accessibilité débutants 65/100
-
Difficulté 2/5 1-3 heures Accessibilité débutants 70/100
nwg-piotr/nwg-displays#145 ·