Skip to content

docs(cacheprovider): add missing docstrings for hooks (pytest_addoption, pytest_configure, cacheshow) #13665

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

Merged

Conversation

ali90h
Copy link
Contributor

@ali90h ali90h commented Aug 21, 2025

Added Sphinx-style docstrings for three functions in src/_pytest/cacheprovider.py:

  • pytest_addoption

  • pytest_configure

  • cacheshow

  • Include documentation when adding new features.

  • Include new tests or update existing tests when applicable.

  • Allow maintainers to push and squash when merging my commits. Please uncheck this if you prefer to squash the commits yourself.

Documentation build

Docs build locally without warnings:

  • tox -e docs → verified HTML output under doc/en/_build/html.

Checklist

  • Include documentation when adding new features or user-facing behavior.
  • Include new tests or update existing tests when applicable. (N/A: docs-only)
  • Allow maintainers to push and squash when merging my commits.
  • Link the issue: Closes Add missing docstrings to public methods in cacheprovider.py (lines 478-586) #13625.
  • Create a new changelog fragment in changelog/ as described above.
  • Add myself to AUTHORS in alphabetical order. (if not already present)

@psf-chronographer psf-chronographer bot added the bot:chronographer:provided (automation) changelog entry is part of PR label Aug 21, 2025
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.

Thanks. Left a small nit which I will take the liberty of applying myself.

@nicoddemus nicoddemus enabled auto-merge (squash) August 22, 2025 10:13
@nicoddemus nicoddemus merged commit 0354e90 into pytest-dev:main Aug 22, 2025
36 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bot:chronographer:provided (automation) changelog entry is part of PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add missing docstrings to public methods in cacheprovider.py (lines 478-586)
2 participants