Be sure to define 'description'

github · Jan 1, 2025 · 76652e8 · 76652e8
1 parent d25344a
commit 76652e8
Showing 1 changed file with 1 addition and 1 deletion.
diff --git a/...acking-your-work-with-issues/using-issues/linking-a-pull-request-to-an-issue.md b/...acking-your-work-with-issues/using-issues/linking-a-pull-request-to-an-issue.md
@@ -20,7 +20,7 @@ shortTitle: Link PR to issue
 ---
 
 > [!NOTE]
-> The special keywords in a pull request description are interpreted when the pull request targets the repository's _default_ branch. However, if the PR's base is _any other branch_, then these keywords are ignored, no links are created and merging the PR has no effect on the issues. **If you want to link a pull request to an issue using a keyword, the PR must be on the default branch.**
+> The special keywords in a pull request description, i.e. the text comment accompanying the title written by the PR author, are interpreted when the pull request targets the repository's _default_ branch. However, if the PR's base is _any other branch_, then these keywords are ignored, no links are created and merging the PR has no effect on the issues. **If you want to link a pull request to an issue using a keyword, the PR must be on the default branch.**
 
 ## About linked issues and pull requests