docs: mention that the changelog block in PR is special

2021-01-19 22:47:40 -05:00
parent 5b43ac42a0
commit 44105ca1f2
1 changed files with 2 additions and 1 deletions
@@ -5,7 +5,8 @@

 ## Suggested changelog entry:

-<!-- fill in the below block with the expected RestructuredText entry (delete if no entry needed) -->
+<!-- Fill in the below block with the expected RestructuredText entry. Delete if no entry needed;
+     but do not delete header or rst block if an entry is needed! Will be collected via a script. -->

 ```rst