python / python/cpython

Better/complete documentation of sys.stdin/stdout/stderr default behavior

Ouverte
#92,298 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

docs
Langage dominant
Python
Étoiles
77.2k
Forks
36k
Métriques de merge des PR
Métriques de PR en attente

Description

See https://docs.python.org/3/library/sys.html?highlight=stdin#sys.stdin
The default behavior of sys.stdin/stdout/stderr is not fully documented (e.g. the default newline mode, depending on OS), and the current existing documentation is a lot more difficult to understand than it would need to be, referring to internal c-api settings instead of explaining in clear language what is going.

Given how important this information is and given that the behavior of sys.stdin/out/err is surprisingly DIFFERENT from what the default would be if open with default settings would be used, making the documentation more complete and easier to understand would be rather important. The number of questions on stackoverlow (partly with incorrect or hard to verify answers) about this is a good indicator of how confusing and important this matter is.

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Commencez par la section consacrée à sys.stdin, sys.stdout et sys.stderr sur la page de documentation Python indiquée, puis comparez sa description avec le comportement de open avec ses paramètres par défaut sur différents systèmes d’exploitation. Le travail est terminé lorsque le comportement par défaut des retours à la ligne et les autres différences pertinentes sont expliqués clairement et avec exactitude, sans recourir à la terminologie interne de la C API.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
python
Domaine
documentation
Type d'issue
Documentation
Difficulté
3/5
Temps estimé
1-2 jours
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
45/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.