Argument clinic: outdated tutorial

Aberta
#1,253 1 comentário 1 reação 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

Avaliação

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

Direção de pesquisa

Abra o tutorial vinculado do Argument Clinic e revise a seção que começa com “First, ensure both places use the same argument-parsing function.” Compare as afirmações dela com a saída e o comportamento atuais de Tools/clinic/clinic.py. A documentação estará concluída quando essa seção descrever com precisão a implementação atual e não apresentar mais o workflow desatualizado de PyArg_ParseTuple*().

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

Descrição

topic-dev process type-bug

Documentation

The tutorial for Argument Clinic in the devguide contains an outdated section. It still describes the early implementation that used to generate calls to PyArg_ParseTuple*() functions. This is no longer the case.

The affected section starts with "First, ensure both places use the same argument-parsing function." and goes for a few paragraphs until "If any of these items differ in any way, adjust your Argument Clinic function specification and rerun Tools/clinic/clinic.py until they are the same."

Given that the output is now very different, this is quite confusing to read. The section probably needs to be completely rewritten.

CC @AlexWaygood @erlend-aasland

Linguagem predominante
Python
Estrelas
2.1k
Forks
1k
Merge médio
2d 12h
PRs com merge (30d)
12

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.

Mais de python/devguide

Todas as issues de python/devguide

Issues semelhantes

Mais issues de Python

Receba novas issues na sua caixa de entrada

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