Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Preserve indentation in multi-line list entry #11

Open
JelleZijlstra opened this issue Apr 8, 2021 · 0 comments
Open

Preserve indentation in multi-line list entry #11

JelleZijlstra opened this issue Apr 8, 2021 · 0 comments

Comments

@JelleZijlstra
Copy link
Member

JelleZijlstra commented Apr 8, 2021

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.

@hugovk hugovk transferred this issue from python/core-workflow Mar 28, 2024
@hugovk hugovk changed the title blurb: preserve indentation in multi-line list entry preserve indentation in multi-line list entry Mar 28, 2024
@hugovk hugovk changed the title preserve indentation in multi-line list entry Preserve indentation in multi-line list entry Mar 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant