Update src/towncrier/test/helpers.py

Co-authored-by: Adi Roiban <[email protected]>
twisted · Nov 9, 2023 · b486693 · b486693
1 parent 875df57
commit b486693
Showing 1 changed file with 7 additions and 2 deletions.
diff --git a/src/towncrier/test/helpers.py b/src/towncrier/test/helpers.py
@@ -80,8 +80,13 @@ def with_project(
 ) -> Callable[[Callable[..., Any]], Callable[..., Any]]:
     """Decorator to run a test with an isolated directory containing a simple
     project.
-    Use `config` to tweak the content of the config file.
-    Use `pyproject_path` to tweak the location of the config file.
+
+    The files are not managed by git.
+
+    `config` is the content of the config file.
+    It will be automatically dedented.
+    
+    `pyproject_path` is the path where to store the config file.
     """
 
     def decorator(fn: Callable[..., Any]) -> Callable[..., Any]: