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

docs: Create links for objects to show the api #2473

Merged
merged 2 commits into from
Jun 6, 2017
Merged

docs: Create links for objects to show the api #2473

merged 2 commits into from
Jun 6, 2017

Conversation

ApaDoctor
Copy link
Contributor

Fixes: #2331
head-fork: ApaDoctor/pytest
compare: docs-fixes

base-fork: pytest-dev/pytest
base: master # if it's a bugfix

@coveralls
Copy link

Coverage Status

Coverage remained the same at 92.133% when pulling 54a90e9 on ApaDoctor:docs-fixes into 5ee9793 on pytest-dev:master.

Copy link
Member

@nicoddemus nicoddemus left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome, thanks for this!

Just two things:

  1. I think this warrants a note in the CHANGELOG. 👍
  2. The change in pluggy.py should be applied upstream.

Other than that it is ready for merging, I've tested the changes locally and they work as expected.

@@ -540,7 +540,7 @@ def add_hookcall_monitoring(self, before, after):
of HookImpl instances and the keyword arguments for the hook call.

``after(outcome, hook_name, hook_impls, kwargs)`` receives the
same arguments as ``before`` but also a :py:class:`_CallOutcome`` object
same arguments as ``before`` but also a :py:class:`_CallOutcome <_pytest.vendored_packages.pluggy._CallOutcome>` object
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This change should be applied in the upstream repository at pytest-dev/pluggy instead.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the real problem is, that we change the absolute path, there - the whole thing is incorrect unless we stop vendoring

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"the whole thing" you mean the entire PR? I don't think so, only the change in pluggy needs to be dropped, the other links work fine.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@nicoddemus what i mean is that the pluggy details we include in the docs go wrong because we change the absolute name of everything inside pluggy due to vendoring (so the change to pluggy is correct for the context of making the pytest docs correct, but it breaks vendoring

@coveralls
Copy link

Coverage Status

Coverage remained the same at 92.133% when pulling 80944e3 on ApaDoctor:docs-fixes into 5ee9793 on pytest-dev:master.

@nicoddemus nicoddemus merged commit 57e2ced into pytest-dev:master Jun 6, 2017
@nicoddemus
Copy link
Member

Thanks again @ApaDoctor!

@ApaDoctor ApaDoctor deleted the docs-fixes branch June 22, 2017 11:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

documentation no longer refers/shows the api of Items
4 participants