Skip to content

DOC Note that changelog entries should contain a single bullet #32085

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 1 commit into from
Sep 3, 2025
Merged

DOC Note that changelog entries should contain a single bullet #32085

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 2 additions & 1 deletion doc/whats_new/upcoming_changes/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,8 @@ This file needs to be added to the right folder like `sklearn.linear_model` or
`sklearn.tree` depending on which part of scikit-learn your PR changes. There
are also a few folders for some topics like `array-api`, `metadata-routing` or `security`.

In almost all cases, your fragment should be formatted as a bullet point.
In almost all cases, your fragment should be formatted as a **single** bullet point.
Note the aggregation software cannot handle more than one bullet point per entry.
Copy link
Member Author

Choose a reason for hiding this comment

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

Not sure that this second line is necessary. Maybe just adding 'single' above is adequate?

Copy link
Member

@lesteve lesteve Sep 3, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

I guess it's not entirely accurate (but probably good enough for now 😉), you can probably do a top-level bullet point and some nested bullet points if you really want (not sure it's a good idea, the changelog is already long enough ...).

I guess the thing to maybe do more is to have a look at the PR rendered doc and check that the changelog looks OK. Not super convenient to get to but it's there somewhere e.g. for this PR: https://output.circle-artifacts.com/output/job/e7181091-4ac6-4397-8fc7-c9c9f3f73475/artifacts/0/doc/whats_new/v1.8.html

Maybe it would be worth adding a changelog link to _changed.html ...
image

Copy link
Member

@lesteve lesteve Sep 3, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

Maybe it would be worth adding a changelog link to _changed.html ...

Actually I double-checked and the functionality is already there. For example #31564, rendered doc shows a link to the changelog (because a file was added in doc/whats_new/upcoming_changes:
image

So I guess it is mostly a matter of remembering to double-check the rendering of the changelog.


For example, `28268.feature.rst` would be added to the `sklearn.ensemble`
folder with the following content::
Expand Down
Loading