tarfile stream restrictions should be documented
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- Python
- Estrellas
- 77.2k
- Forks
- 35.9k
- Métricas de merge de PR
- Métricas de PR pendientes
Descripción
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.
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
Comienza con la documentación de tarfile.open y su sección Examples. Después, revisa los métodos documentados de TarFile en busca de operaciones que requieran acceso aleatorio. Documenta las restricciones del modo de flujo donde se apliquen y añade un ejemplo que demuestre el modo de flujo, asegurándote de que la documentación resultante identifique claramente las operaciones no disponibles.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- python
- Área
- documentation
- Tipo de issue
- Documentación
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 48/100