docs: link the current pytest-xdist newhooks.py from the hooks how-to#14503
Merged
nicoddemus merged 2 commits intoMay 23, 2026
Merged
Conversation
The "writing hook functions" how-to pointed at a frozen 974bd566 commit under xdist/newhooks.py, before the xdist layout moved hooks into src/xdist/. Point the link at master/src so the example tracks the project as it ships today, and add a doc changelog entry. Closes pytest-dev#14465.
psf-chronographer
Bot
added
the
bot:chronographer:provided
Address maintainer feedback on the related issue: a release tag is preferable to the moving master branch for the how-to link, because the tag stays in sync with the version of pytest-xdist users actually install via pip. master would drift the moment xdist refactors its hook layout again. Also reworded the changelog entry to match the new approach. Targets pytest-xdist v3.8.0 (latest release as of 2025-07-01).
Contributor
Author
|
Thanks for the quick review and merge. Glad the v3.8.0 tag pin was the right call. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Closes #14465.
The how-to page for declaring new hooks points readers at
newhooks.pyinpytest-xdistas a real-world example, but the link is pinned to a 2017-era commit (974bd566) under the oldxdist/layout. xdist has since moved its hooks undersrc/xdist/, so following the link lands on an outdated snapshot rather than the file readers will see if they open the repository today.This PR repoints the link at
master/src/xdist/newhooks.py. The current file shows the same idea (declaring new hook specs) but matches what the project ships today, including the explicit@pytest.hookspecmarkers the issue mentioned.I kept the PR narrow to the link change and a changelog entry, per the reporter's question in the issue. Happy to follow up with a separate PR if the maintainers want the how-to to also recommend
@hookspecand@hookimplmore explicitly.Test plan
curl -I https://github.com/pytest-dev/pytest-xdist/blob/master/src/xdist/newhooks.pyreturns 200.newhooks.py(top docstring reads "xdist hooks.").changelog/14465.doc.rstper CONTRIBUTING..rst, no Sphinx directive added).