python / python/cpython

Incorrect default compresslevel (9) in gzip documentation

Ouverte
#152,633 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

docs
Langage dominant
Python
Étoiles
77.2k
Forks
35.9k
Métriques de merge des PR
Métriques de PR en attente

Description

Documentation

The default compresslevel for gzip.open(), the GzipFile constructor, and gzip.compress() is COMPRESS_LEVEL_TRADEOFF (6). The signatures and the "Changed in version" notes in Doc/library/gzip.rst already reflect this (it says "the default compression level was reduced to 6, down from 9").
However, a few places still state the default is 9 and should be updated:-

  1. the gzip.open() docstring in Lib/gzip.py
  2. the GzipFile.init docstring in Lib/gzip.py
  3. the GzipFile paragraph in Doc/library/gzip.rst
Linked PRs
  • gh-152634

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Lisez Lib/gzip.py et Doc/library/gzip.rst, en vérifiant les trois emplacements indiqués de docstrings et de paragraphes par rapport aux signatures et aux notes de version existantes. C’est terminé lorsque toutes les affirmations restantes à ces emplacements décrivent systématiquement le niveau de compression par défaut comme étant 6 plutôt que 9.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
python
Domaine
documentation
Type d'issue
Documentation
Difficulté
1/5
Temps estimé
1-3 heures
Activité
Calme
Clarté
Clairement spécifiée
Accessibilité débutants
30/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.