Skip to content

[misc] automatically strip periods when generating changelog entries #18598

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Feb 5, 2025
Merged

[misc] automatically strip periods when generating changelog entries #18598

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
aac7261
[misc] automatically strip periods when generating changelog entries
wesleywright Feb 4, 2025
9bdb536
split out `title` variable for readability & to placate self typechec…
wesleywright Feb 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion misc/generate_changelog.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@ def format_changelog_entry(c: CommitInfo) -> str:
s += f" (#{c.pr_number})"
s += f" ({c.author})"
"""
s = f" * {c.title} ({c.author}"
s = f" * {c.title.removesuffix(".")} ({c.author}"
Copy link
Collaborator

@hauntsaninja hauntsaninja Feb 5, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
s = f" * {c.title.removesuffix(".")} ({c.author}"
s = f" * {c.title.removesuffix('.')} ({c.author}"

Copy link
Collaborator Author

@wesleywright wesleywright Feb 5, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I already had a local commit to fix this by breaking it out into a separate variable, but I logged off before remembering to push it, haha. I'm opting to keep that approach for the slight readability advantage.

if c.pr_number:
s += f", PR [{c.pr_number}](https://github.com/python/mypy/pull/{c.pr_number})"
s += ")"
Expand Down
Loading