Merge pull request #425 from jenshnielsen/fix_readme_typo

Fix documentation of fragment configuration in README
twisted · Sep 6, 2022 · 474e489 · 474e489
2 parents 5fb8fc8 + 698288d
commit 474e489
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 3 deletions.
diff --git a/README.rst b/README.rst
@@ -173,12 +173,12 @@ Furthermore, you can customize each of your own fragment types using:
 
     [tool.towncrier]
 	# To add custom fragment types, with default setting, just add an empty section.
-    [tool.towncrier.feat]
-    [tool.towncrier.fix]
+    [tool.towncrier.fragment.feat]
+    [tool.towncrier.fragment.fix]
 
 	# Custom fragment types can have custom attributes
 	# that are used when rendering the result based on the template.
-    [tool.towncrier.chore]
+    [tool.towncrier.fragment.chore]
         name = "Other Tasks"
         showcontent = false
 

diff --git a/src/towncrier/newsfragments/424.doc b/src/towncrier/newsfragments/424.doc
@@ -0,0 +1 @@
+Correct a typo in the readme that incorrectly documented custom fragments in a format that does not work.