Skip to content

fix(upgrade): emit dash bullets in changelog#3182

Merged
gaborbernat merged 1 commit into
mainfrom
fix/upgrade-changelog-bullet
Jul 6, 2026
Merged

fix(upgrade): emit dash bullets in changelog#3182
gaborbernat merged 1 commit into
mainfrom
fix/upgrade-changelog-bullet

Conversation

@gaborbernat

Copy link
Copy Markdown
Contributor

_write_changelog in tasks/upgrade_wheels.py rendered upgrade list items with *, but the repo's docstrfmt pre-commit hook normalizes bullet lists to -. Every auto-generated upgrade PR failed docstrfmt until the bullet was fixed by hand (e.g. #3180).

Emit - so the generated fragment is clean on the first try.

Task-script-only change, so no changelog fragment (matches #3143).

_write_changelog rendered list items with ``*``, but the repo's
docstrfmt pre-commit hook normalizes bullet lists to ``-``. Every
auto-generated upgrade PR therefore failed docstrfmt until fixed by
hand (see #3180). Emit ``-`` so the fragment is clean on the first try.
@gaborbernat
gaborbernat merged commit 1fa46f5 into main Jul 6, 2026
57 checks passed
@gaborbernat
gaborbernat deleted the fix/upgrade-changelog-bullet branch July 6, 2026 15:18
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

Successfully merging this pull request may close these issues.

1 participant