Skip to content

docs(markers): document & and | operators for combining Marker objects - #1151

Merged
henryiii merged 2 commits into
pypa:mainfrom
r266-tech:docs-marker-operators
Apr 8, 2026
Merged

henryiii merged 2 commits into
pypa:mainfrom
r266-tech:docs-marker-operators

Conversation

@r266-tech

Copy link
Copy Markdown
Contributor

Summary

PR #1146 added __and__ and __or__ operators to Marker, allowing programmatic combination via & and |. The documentation in markers.rst didn't include these new operators.

This PR adds:

  1. Usage section: A new "Combining markers programmatically" subsection with doctest examples showing & and | usage
  2. Reference section: Added :special-members: __and__, __or__ to the automodule directive so the operators appear in the API reference

Changes

  • docs/markers.rst: Added doctest examples and Sphinx autodoc config for the new operators

Comment thread docs/markers.rst Resolved
Comment thread docs/markers.rst Resolved
Per review feedback from henryiii.
@henryiii
henryiii enabled auto-merge (squash) April 8, 2026 16:26
@henryiii
henryiii merged commit 6762eea into pypa:main Apr 8, 2026
55 checks passed
This was referenced Apr 13, 2026
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.

2 participants