DOC Note that changelog entries should contain a single bullet #32085
Conversation
| @@ -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. | |||
There was a problem hiding this comment.
Not sure that this second line is necessary. Maybe just adding 'single' above is adequate?
There was a problem hiding this comment.
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 ...
There was a problem hiding this comment.
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:
So I guess it is mostly a matter of remembering to double-check the rendering of the changelog.
|
cc @ogrisel |
Reference Issues/PRs
ref: #32081 (comment)
What does this implement/fix? Explain your changes.
Add note that changelog entries should be a single bullet point
Any other comments?