pytest-dev / pytest-dev/pytest

Docs: collection hooks listed under reporting hooks

Open
#12,658 9 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

type: docs
Dominant language
Python
Stars
14.5k
Forks
3.4k
Avg merge
2d 9h
Merged PRs (30d)
35

Description

In the docs, under "reporting hooks" I see a couple of hooks that I would expect under "collection hooks":

  • pytest_collectstart
  • pytest_make_collect_report
  • pytest_itemcollected
  • pytest_collectreport
  • pytest_deselected

https://github.com/pytest-dev/pytest/blob/6c806b499ddbb844753b5c8c4d70a8b98b9d1c3a/doc/en/reference/reference.rst?plain=1#L759-L773

is that intended for some reason?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with doc/en/reference/reference.rst around lines 759-773 and review the issue discussion to determine whether these five hooks belong under collection hooks. Once the intended categorization is confirmed, update the documentation so the hooks appear in the agreed section and verify the surrounding hook lists remain accurate.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.