Fix the type annotation for sphinx.testing.fixtures.rootdir
#12764
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Subject: Tweak
rootdir
fixture's type hintFeature or Bugfix
Purpose
https://www.sphinx-doc.org/en/master/extdev/testing.html#usage
In
tests/conftest.py
, I noticed thatrootdir
returnspathlib.Path
instead ofstr
.sphinx/tests/conftest.py
Lines 43 to 45 in 043750e
rootdir
insphinx/testing/fixture.py
is type-hinted as returningstr
sphinx/sphinx/testing/fixtures.py
Lines 44 to 46 in 043750e
but
rootdir
is treated aspathlib.Path
inapp_params
fixture.sphinx/sphinx/testing/fixtures.py
Lines 110 to 112 in 043750e
pathlib.Path
/str
: works!str
/str
: not workDetail
(See Purpose. That's all)
Relates