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

Moving of _pytest.python.Function, *.Class and *.Module in intersphinx dictionary #7725

Closed
robsan00 opened this issue Sep 6, 2020 · 3 comments
Labels
type: docs documentation improvement, missing or needing clarification type: question general question, might be closed after 2 weeks of inactivity

Comments

@robsan00
Copy link

robsan00 commented Sep 6, 2020

I have seen that the references to "_pytest.python.Function", "_pytest.python.Class" and "_pytest.python.Module" have been moved to "pytest.Function", "pytest.Class" and "pytest.Module" in the intersphinx dictionary. Is there any specific reason for that (considering that there are still loads of _pytest... references in the intersphinx dictionary).

From an older intersphinx dictionary, I had cached locally (string unzipped):

(...)
_pytest.pytester.Testdir.syspathinsert py:method 1 reference.html#$ -
_pytest.python.Class py:class 1 reference.html#$ -
_pytest.python.Class.collect py:method 1 reference.html#$ -
_pytest.python.Function py:class 1 reference.html#$ -
_pytest.python.Function.function py:attribute 1 reference.html#$ -
_pytest.python.Function.originalname py:attribute 1 reference.html#$ -
_pytest.python.Function.runtest py:method 1 reference.html#$ -
_pytest.python.Function.setup py:method 1 reference.html#$ -
_pytest.python.Metafunc py:class 1 reference.html#$ -
_pytest.python.Metafunc.cls py:attribute 1 reference.html#$ -
_pytest.python.Metafunc.config py:attribute 1 reference.html#$ -
_pytest.python.Metafunc.fixturenames py:attribute 1 reference.html#$ -
_pytest.python.Metafunc.function py:attribute 1 reference.html#$ -
_pytest.python.Metafunc.module py:attribute 1 reference.html#$ -
_pytest.python.Metafunc.parametrize py:method 1 reference.html#$ -
_pytest.python.Module py:class 1 reference.html#$ -
_pytest.python.Module.collect py:method 1 reference.html#$ -
_pytest.python_api.approx py:function 1 reference.html#$ -
(...)

Latest:

(...)
_pytest.pytester.Testdir.syspathinsert py:method 1 reference.html#pytest.pytester.Testdir.syspathinsert -
_pytest.python.Metafunc py:class 1 reference.html#pytest.python.Metafunc -
_pytest.python.Metafunc.cls py:attribute 1 reference.html#pytest.python.Metafunc.cls -
_pytest.python.Metafunc.config py:attribute 1 reference.html#pytest.python.Metafunc.config -
_pytest.python.Metafunc.fixturenames py:attribute 1 reference.html#pytest.python.Metafunc.fixturenames -
_pytest.python.Metafunc.function py:attribute 1 reference.html#pytest.python.Metafunc.function -
_pytest.python.Metafunc.module py:attribute 1 reference.html#pytest.python.Metafunc.module -
_pytest.python.Metafunc.parametrize py:method 1 reference.html#pytest.python.Metafunc.parametrize -
_pytest.recwarn.WarningsRecorder py:class 1 reference.html#pytest.recwarn.WarningsRecorder -
(...)
@Zac-HD Zac-HD added type: docs documentation improvement, missing or needing clarification type: question general question, might be closed after 2 weeks of inactivity labels Sep 6, 2020
@bluetech
Copy link
Member

bluetech commented Sep 6, 2020

We are working on better capturing what is our public API and what is internal (see #7469). As part of this effort I moved links in the reference which are already publicly exposed to their public paths. Names which are not yet exposed were left as-is.

Now that I know about this issue, I will try to keep the next update to one big batch.

Regarding the changes that were already made, does it cause a lot of trouble for you?

@robsan00
Copy link
Author

robsan00 commented Sep 7, 2020

Regarding the changes that were already made, does it cause a lot of trouble for you?

No, there is nothing that cannot be fixed with a quick search + replace.

@bluetech
Copy link
Member

bluetech commented Sep 7, 2020

OK, so we'll keep the changes, but as said will try to keep it as one big change next time.

@bluetech bluetech closed this as completed Sep 7, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: docs documentation improvement, missing or needing clarification type: question general question, might be closed after 2 weeks of inactivity
Projects
None yet
Development

No branches or pull requests

3 participants