python / python/blurb

Preserve indentation in multi-line list entry

Ouverte
#11 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Langage dominant
Python
Étoiles
22
Forks
13
Merge moyen
4 h 3 min
PR mergées (30 j)
5

Description

I would like to put this in a NEWS entry:

The following `threading` methods are now deprecated and should be replaced:

- `threading.activeCount` => :func:`threading.active_count`

- `threading.Condition.notifyAll` =>
    :meth:`threading.Condition.notify_all`

But when blurb generates the NEWS file, it produces:

- bpo-43723: The following `threading` methods are now deprecated and should
  be replaced:

  - `threading.activeCount` => :func:`threading.active_count`

  - `threading.Condition.notifyAll` =>
  :meth:`threading.Condition.notify_all`

Which is invalid rst, because the second line of the list is not indented enough.

It's because blurb uses textwrap.wrap to reflow the text, and that function eats any leading space in the line. Fixing this might require doing something more RST-aware.

Guide de contribution

Aucun guide de contribution indexé pour ce dépôt

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

Commencez par localiser l'utilisation de Python's textwrap.wrap dans blurb et reproduisez le problème avec l'entrée NEWS présentée ici. Suivez la manière dont les entrées de liste multilignes sont reformatées, puis vérifiez que la sortie générée conserve l'indentation requise pour un reStructuredText valide.

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

Évaluation

Stack technique
python
Domaine
cli
Type d'issue
Bug
Difficulté
3/5
Temps estimé
1-2 jours
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
45/100

Recevez les nouvelles issues par e-mail

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