Improve the frozenset.is(sub|super)set docstrings
Aberta
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
RE: Documentation provided by built-in function help()
While reviewing built-in methods in detail I made note of:
- "help(frozenset)" issubset and issuperset methods both return bool type
Other comments that were not issues
See https://github.com/python/cpython/issues/129622#issuecomment-2633394435.
- "help(slice)" third parameter typo
- "help(range)" third parameter typo
- "help(float)" quizzical hex method example
- "help(bool)" is bit_length method also for absolute value of self?
- "help(bool)" is_integer appears duck-like compatible with int (TypeError with float)
- "help(bool)" from_bytes appears to return a bool from byte array
Regards,
'EntryLevelJobSeeker'
Linked PRs
- gh-129637
Guia de contribuição
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Direção de pesquisa
Comece executando help(frozenset) e revisando as docstrings de issubset e issuperset no código-fonte do CPython. Compare a redação delas com o comportamento de retorno bool dos métodos; a documentação estará concluída quando ambas as docstrings descreverem corretamente esse resultado. O PR vinculado gh-129637 indica que esse trabalho já está em andamento.
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
- Razoavelmente clara
- Facilidade para iniciantes
- 25/100