python / python/cpython

Tutorial - Section 4 Has Numerous Problems

Ouverte
#119,997 2 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
35.9k
Métriques de merge des PR
Métriques de PR en attente

Description

Documentation

Remember, the target audience for the tutorial are people with no prior Python knowledge. Given this, there are a few problems:

  • Section 4.2: The second code example uses dictionaries but they have not been introduced - and they appear again in a bullet point in Section 4.6.
  • Section 4.2: (Same code example.) Furthermore, while users and users.copy() might make some intuitive sense, a brief explanation of what items() does seems necessary, otherwise people will think "I guess I just have to write this even though I have no idea why".
  • Section 4.6: __match_args__ is poorly introduced. It is explained that if it's set a certain way, it's possible to write patterns in a certain way but it's not made clear how to set it until the following example, which is about nesting patterns. This might lead readers to get stuck before it's even clarified.
  • Section 4.6: It seems like some of the bullet points at the end of this section were written in a rush, assume prior knowledge of Python, and do not follow the pace of the tutorial. (We've had a bunch of questions on Discord from people who essentially didn't understand anything that was written there.)

It seems like a lot of this has been copied over almost verbatim from PEP-636, which shares the same problems.

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 lire les sections 4.2 et 4.6 du tutoriel, puis comparez le contenu associé dans PEP-636. Vérifiez que dictionaries et items() sont présentés avant leur utilisation, que match_args est expliqué avant sa syntaxe de motifs et que les derniers points sont compréhensibles pour des lecteurs n’ayant aucune connaissance préalable de Python. Le travail est terminé lorsque ces sections sont compréhensibles sans les questions Discord décrites dans l’issue.

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
35/100

Recevez les nouvelles issues par e-mail

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