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 changes about limitations with hook function ordering #11635

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

jack-zj-liu
Copy link

This PR is to address the issue in #11307.

Approach 2 is taken, where a link to the limitations is added to hook function ordering, so users will be aware of the limitations even when not declaring new hooks. The limitations were previously only in the Declaring New Hooks section.

Copy link
Member

@bluetech bluetech left a comment

Choose a reason for hiding this comment

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

Thanks @jack-zj-liu, please see my comment.

@@ -117,6 +117,10 @@ Hook function ordering / call example
For any given hook specification there may be more than one
implementation and we thus generally view ``hook`` execution as a
``1:N`` function call where ``N`` is the number of registered functions.

There are certain limitations about hooks starting with ``_pytest``. For
Copy link
Member

Choose a reason for hiding this comment

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

The problematic prefix is pytest_ (not _pytest).

It is not clear which limitations this comment refers to, and the "Declaring new hooks" section doesn't mention any.

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.

None yet

2 participants