Merge pull request #9970 from ezio-melotti/fix-tempdirfactory-docstring

Fix rst markup in TempdirFactory's docstring.

Author: nicoddemus

.pre-commit-config.yaml

@@ -101,7 +101,7 @@ repos:
         types: [python]
     -   id: py-path-deprecated
         name: py.path usage is deprecated
-        exclude: docs|src/_pytest/deprecated.py|testing/deprecated_test.py
+        exclude: docs|src/_pytest/deprecated.py|testing/deprecated_test.py|src/_pytest/legacypath.py
         language: pygrep
         entry: \bpy\.path\.local
         types: [python]

src/_pytest/legacypath.py

@@ -270,8 +270,8 @@ def testdir(pytester: Pytester) -> Testdir:
 @final
 @attr.s(init=False, auto_attribs=True)
 class TempdirFactory:
-    """Backward compatibility wrapper that implements :class:``_pytest.compat.LEGACY_PATH``
-    for :class:``TempPathFactory``."""
+    """Backward compatibility wrapper that implements :class:`py.path.local`
+    for :class:`TempPathFactory`."""
 
     _tmppath_factory: TempPathFactory
 
@@ -282,11 +282,11 @@ def __init__(
         self._tmppath_factory = tmppath_factory
 
     def mktemp(self, basename: str, numbered: bool = True) -> LEGACY_PATH:
-        """Same as :meth:`TempPathFactory.mktemp`, but returns a ``_pytest.compat.LEGACY_PATH`` object."""
+        """Same as :meth:`TempPathFactory.mktemp`, but returns a :class:`py.path.local` object."""
         return legacy_path(self._tmppath_factory.mktemp(basename, numbered).resolve())
 
     def getbasetemp(self) -> LEGACY_PATH:
-        """Backward compat wrapper for ``_tmppath_factory.getbasetemp``."""
+        """Same as :meth:`TempPathFactory.getbasetemp`, but returns a :class:`py.path.local` object."""
         return legacy_path(self._tmppath_factory.getbasetemp().resolve())