tarfile stream restrictions should be documented
Ninguém assumiu esta issue ainda.
- Linguagem predominante
- Python
- Estrelas
- 77.2k
- Forks
- 36k
- Métricas de merge de PRs
- Métricas de PR pendentes
Descrição
Documentation
tarfile documentation mentions stream mode only in tarfile.open, and says "However, such a TarFile object is limited in that it does not allow random access, see Examples."
The examples section does not showcase stream mode at all.
I believe all methods that might be unavailable in stream mode should be documented as such.
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 pela documentação de tarfile.open e pela seção Examples e, em seguida, revise os métodos documentados de TarFile em busca de operações que exijam acesso aleatório. Documente as restrições do modo de fluxo onde quer que se apliquem e adicione um exemplo que demonstre o modo de fluxo, garantindo que a documentação resultante identifique claramente as operações indisponíveis.
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
- 48/100