docs: Run doctests

.github/workflows/test.yaml

@@ -74,6 +74,7 @@ jobs:
     runs-on: ${{ matrix.os }}
     continue-on-error: ${{ matrix.experimental }}
     env:
+      HATCH_ENV: all
       HATCH_VERBOSE: "3"
     strategy:
       fail-fast: false
@@ -110,14 +111,14 @@ jobs:
         run: |
           pipx install hatch
       - name: Run tests
-        env:
-          HATCH_ENV: all
         run: |
           hatch run +py=${{ matrix.python-version }} cov
       - uses: actions/upload-artifact@v4
         with:
           name: coverage-data-${{ matrix.os }}-${{ matrix.python-version }}
           path: ".coverage.*"
+      - name: Run doctests
+        run: hatch run +py=${{ matrix.python-version }} doctest
 
   coverage:
     name: Coverage

pyproject.toml

@@ -66,6 +66,7 @@ matrix.python.env-vars = [
 ]
 [tool.hatch.envs.default.scripts]
 test = "pytest {args:tests}"
+doctest = "pytest --doctest-modules {args:src/pep610}"
 cov = "coverage run -m pytest {args:tests}"
 
 [[tool.hatch.envs.all.matrix]]

src/pep610/__init__.py

@@ -156,6 +156,18 @@ def is_editable(self: Self) -> bool:
 
         Returns:
             Whether the distribution is installed in editable mode.
+
+        >>> dir_info = DirInfo(editable=True)
+        >>> dir_info.is_editable()
+        True
+
+        >>> dir_info = DirInfo(editable=False)
+        >>> dir_info.is_editable()
+        False
+
+        >>> dir_info = DirInfo(editable=None)
+        >>> dir_info.is_editable()
+        False
         """
         return self.editable is True