diff --git a/src/changelist/_format.py b/src/changelist/_format.py index 91eb794..e9939e9 100644 --- a/src/changelist/_format.py +++ b/src/changelist/_format.py @@ -33,7 +33,7 @@ def from_pull_requests( Create one or more notes describing an atomic change from each given pull request. - `pr_summary_regex` is used to detect one or multiple notes in a pull + `pr_summary_regex` is used to detect one or multiple notes in a pull request description that will be used instead of the pull request title if present. This uncouples pull requests and notes somewhat. While ideally, a pull request introduces a change that would be described in