Apply suggestions from code review

Co-authored-by: Bruno Oliveira <[email protected]>
pytest-dev · Nov 21, 2024 · a76eb1f · a76eb1f
1 parent 4391b12
commit a76eb1f
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 2 deletions.
diff --git a/changelog/12981.bugfix.rst b/changelog/12981.bugfix.rst
@@ -1 +1 @@
-Prevent exceptions in pytest.Config.add_cleanup preventing further cleanups
+Prevent exceptions in :func:`pytest.Config.add_cleanup` preventing further cleanups.
diff --git a/src/_pytest/config/__init__.py b/src/_pytest/config/__init__.py
@@ -1110,7 +1110,10 @@ def inipath(self) -> pathlib.Path | None:
 
     def add_cleanup(self, func: _T_callback) -> _T_callback:
         """Add a function to be called when the config object gets out of
-        use (usually coinciding with pytest_unconfigure)."""
+        use (usually coinciding with pytest_unconfigure).
+        
+        Returns the passed function.
+        """
         self._exit_stack.callback(func)
         return func