Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

_pytest.pytester.Testdir missing in objects.inv #7892

Closed
PhilippSelenium opened this issue Oct 13, 2020 · 2 comments · Fixed by #7893
Closed

_pytest.pytester.Testdir missing in objects.inv #7892

PhilippSelenium opened this issue Oct 13, 2020 · 2 comments · Fixed by #7893
Labels
good first issue easy issue that is friendly to new contributor type: docs documentation improvement, missing or needing clarification

Comments

@PhilippSelenium
Copy link

PhilippSelenium commented Oct 13, 2020

I don't know if this was by choice or by accident but the documentation for _pytest.pytester.Testdir is missing in the intersphinx file:

python3 -m sphinx.ext.intersphinx https://docs.pytest.org/en/latest/objects.inv | grep Testdir

pytest version: 6.1.1

@nicoddemus
Copy link
Member

Hi @PhilippSelenium,

That's due to #7854: we introduced Pytester, and because Testdir and Pytester both have the same interface, we decided to show the members of Pytester in the docs only: https://docs.pytest.org/en/latest/reference.html#pytest.pytester.Pytester.

However thinking about this a bit more I'm not sure this is ideal: Pytester now will tend to gain extra functionality which we don't plan to backport to Testdir (I think at least), so we really should show members of both classes in the docs.

Also notice that your link points to the "latest" docs, which are actually master, for version 6.1.1 you should use https://docs.pytest.org/en/stable/objects.inv instead, which still contain the intersphinx docs for Testdir.

@nicoddemus nicoddemus added good first issue easy issue that is friendly to new contributor type: docs documentation improvement, missing or needing clarification labels Oct 13, 2020
@PhilippSelenium
Copy link
Author

@nicoddemus Thanks for the hint. I should use stable.

nicoddemus added a commit to nicoddemus/pytest that referenced this issue Oct 13, 2020
Also include docstrings pointing to the counterparts in Pytester.

Fix pytest-dev#7892
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue easy issue that is friendly to new contributor type: docs documentation improvement, missing or needing clarification
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants