Add comments

pyproject.toml

@@ -201,16 +201,19 @@ search = 'version = "{current_version}"'
 replace = 'version = "{new_version}"'
 
 [[tool.bumpversion.files]]
+# Update the version in changelog written in Markdown with sphinx.ext.extlinks's {gh} shortcut.
 filename = "./changelog.md"
-search = "{{gh}}`{current_version} (unreleased)"
-replace = "{{gh}}`{new_version} (unreleased)"
+search = "## {{gh}}`{current_version} (unreleased) "
+replace = "## {{gh}}`{new_version} (unreleased) "
 
 [[tool.bumpversion.files]]
+# Update the version in the citation file.
 filename = "./citation.cff"
 search = "version: {current_version}"
 replace = "version: {new_version}"
 
 [[tool.bumpversion.files]]
+# Update the release date in the citation file.
 filename = "./citation.cff"
 regex = true
 search = "date-released: \\d{{4}}-\\d{{2}}-\\d{{2}}"