python / python/cpython

Misplaced or duplicated function descriptions in the multiprocessing documentation

Aberta
#97,847 0 comentários 0 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

docs topic-multiprocessing
Linguagem predominante
Python
Estrelas
77.2k
Forks
36k
Métricas de merge de PRs
Métricas de PR pendentes

Descrição

Documentation

In the documentation of the multiprocessing module, some public functions of the root module are undocumented but their submodule counterparts are (misplaced information):

And some public functions of the root module are documented but also their submodule counterparts (duplicated information):

Linked PRs
  • gh-31482

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 pela página de documentação de multiprocessing e compare as entradas do módulo raiz com as seções sharedctypes e pool. Verifique as exportações correspondentes em Lib/multiprocessing/context.py e, em seguida, atualize a documentação para que RawValue, RawArray e Pool sejam contemplados, enquanto Value e Array não sejam duplicados; gh-31482 está listado como um PR vinculado.

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
2/5
Tempo estimado
1-3 horas
Status de atividade
Estagnada
Clareza
Claramente especificada
Facilidade para iniciantes
30/100

Receba novas issues na sua caixa de entrada

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