Commit 993ee06
committed
fix(pytest_plugin): clean up docstrings for autofixture extension compatibility
why: The new sphinx_pytest_fixtures extension auto-generates "Used by"
and "Returns" fields from introspection, so hand-written duplicates
cause double rendering. Cross-references also need :fixture: role
instead of :func: to resolve against the new py:fixture domain object.
what:
- Change :func:`user_path` to :fixture:`user_path` in home_user_name
docstring
- Remove manual "Used by: :func:`config_file`, :func:`zshrc`" from
user_path docstring (now auto-generated)
- Remove redundant Returns section from TestServer docstring (return
type is inferred from the annotation)1 parent 832206b commit 993ee06
1 file changed
Lines changed: 1 addition & 8 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
32 | 32 | | |
33 | 33 | | |
34 | 34 | | |
35 | | - | |
| 35 | + | |
36 | 36 | | |
37 | 37 | | |
38 | 38 | | |
39 | 39 | | |
40 | 40 | | |
41 | 41 | | |
42 | 42 | | |
43 | | - | |
44 | | - | |
45 | 43 | | |
46 | 44 | | |
47 | 45 | | |
| |||
274 | 272 | | |
275 | 273 | | |
276 | 274 | | |
277 | | - | |
278 | | - | |
279 | | - | |
280 | | - | |
281 | | - | |
282 | 275 | | |
283 | 276 | | |
284 | 277 | | |
| |||
0 commit comments