Skip to content

Commit 16748ae

Browse files
authored
[tests] update the pytest.mark.sphinx signature description (#12104)
1 parent 4ca034b commit 16748ae

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

sphinx/testing/fixtures.py

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,14 @@
1919
from typing import Any
2020

2121
DEFAULT_ENABLED_MARKERS = [
22+
# The marker signature differs from the constructor signature
23+
# since the way it is processed assumes keyword arguments for
24+
# the 'testroot' and 'srcdir'.
2225
(
2326
'sphinx('
24-
'buildername="html", /, *, '
25-
'testroot="root", confoverrides=None, freshenv=False, '
27+
'buildername="html", *, '
28+
'testroot="root", srcdir=None, '
29+
'confoverrides=None, freshenv=False, '
2630
'warningiserror=False, tags=None, verbosity=0, parallel=0, '
2731
'keep_going=False, builddir=None, docutils_conf=None'
2832
'): arguments to initialize the sphinx test application.'

0 commit comments

Comments
 (0)