Skip to content

Commit 101e628

Browse files
committed
Fix doc build
1 parent 42bee76 commit 101e628

File tree

2 files changed

+11
-5
lines changed

2 files changed

+11
-5
lines changed

Makefile

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
# Updated: 2022-09-01
66
#
77

8-
.PHONY: build create-venv help prebuild publish test test-all update-venv
8+
.PHONY: build create-venv help prebuild publish test test-all test-doc update-venv
99

1010
help:
1111
@echo "Usage: make [<target>]"
@@ -22,6 +22,7 @@ help:
2222
@echo " create-venv Create the development Python virtual environment."
2323
@echo " test Run tests using the development virtual environment."
2424
@echo " test-all Run tests using Tox for all virtual environments."
25+
@echo " test-doc Run tests using Tox for just documentation."
2526
@echo " update-venv Update the development Python virtual environment."
2627

2728
build: dist-build
@@ -36,6 +37,8 @@ test: dev-test-primary
3637

3738
test-all: dev-test-all
3839

40+
test-doc: dev-test-doc
41+
3942
update-venv: dev-venv-install
4043

4144

@@ -49,11 +52,14 @@ VENV_DIR := ./dev/venv
4952
PYTHON := python3
5053
VENV := ./dev/venv.sh "${VENV_DIR}"
5154

52-
.PHONY: dev-test-all dev-test-primary dev-venv-base dev-venv-create dev-venv-install
55+
.PHONY: dev-test-all dev-test-doc dev-test-primary dev-venv-base dev-venv-create dev-venv-install
5356

5457
dev-test-all:
5558
${VENV} tox
5659

60+
dev-test-doc:
61+
${VENV} tox -e doc
62+
5763
dev-test-primary:
5864
${VENV} python -m unittest -v
5965

pathspec/pathspec.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ def check_file(
112112
:data:`None`) optionally contains the path separators to normalize. See
113113
:func:`~pathspec.util.normalize_file` for more information.
114114
115-
Returns the file check result (:class:`CheckResult`).
115+
Returns the file check result (:class:`~pathspec.util.CheckResult`).
116116
"""
117117
norm_file = normalize_file(file, separators)
118118
include, index = self._match_file(enumerate(self.patterns), norm_file)
@@ -135,7 +135,7 @@ def check_files(
135135
:func:`~pathspec.util.normalize_file` for more information.
136136
137137
Returns an :class:`~collections.abc.Iterator` yielding each file check
138-
result (:class:`CheckResult`).
138+
result (:class:`~pathspec.util.CheckResult`).
139139
"""
140140
if not _is_iterable(files):
141141
raise TypeError(f"files:{files!r} is not an iterable.")
@@ -174,7 +174,7 @@ def check_tree_files(
174174
:data:`False`.
175175
176176
Returns an :class:`~collections.abc.Iterator` yielding each file check
177-
result (:class:`CheckResult`).
177+
result (:class:`~pathspec.util.CheckResult`).
178178
"""
179179
files = util.iter_tree_files(root, on_error=on_error, follow_links=follow_links)
180180
yield from self.check_files(files)

0 commit comments

Comments
 (0)