Skip to content

Write up a prerelease without summary paragraphs #3091

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
soutaro merged 1 commit into from
Aug 18, 2026
+2 −1
Merged

Write up a prerelease without summary paragraphs #3091

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 docs/release.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,8 @@ The sections always appear in this order; delete the ones that end up empty, whi
on a small release. Two things scale with the size of the release:

- **Summary paragraphs**, above the first section. A patch release usually has none, 4.1.0 has four
paragraphs, and 4.0.0 has nine.
paragraphs, and 4.0.0 has nine. A prerelease has none whatever its size: the cycle it belongs to
is summarized once, on the release proper that folds it in.
- **A list of the types whose signatures changed**, as the first line of `### Signature updates`,
written as `**Updated classes/modules/methods:**` followed by the names in backticks. Used on
`X.Y.0` releases only.
Expand Down
Loading