python / python/cpython

Tutorial - Section 4 Has Numerous Problems

Aberta
#119,997 2 comentários 0 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

docs
Linguagem predominante
Python
Estrelas
77.2k
Forks
35.9k
Métricas de merge de PRs
Métricas de PR pendentes

Descrição

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.

Guia de contribuição

Abrir o guia de contribuição

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Direção de pesquisa

Comece lendo as Seções 4.2 e 4.6 do tutorial e, em seguida, compare o material relacionado em PEP-636. Verifique se dictionaries e items() são introduzidos antes de serem usados, se match_args é explicado antes de sua sintaxe de padrões e se os tópicos finais são compreensíveis para leitores sem conhecimento prévio de Python. Considera-se concluído quando essas seções forem compreensíveis sem as perguntas do Discord descritas na issue.

Escrita pelo modelo de indexação a partir do texto da issue.

Avaliação

Stack de tecnologia
python
Domínio
documentation
Tipo de issue
Documentação
Dificuldade
3/5
Tempo estimado
1-2 dias
Status de atividade
Estagnada
Clareza
Razoavelmente clara
Facilidade para iniciantes
35/100

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.