Repository navigation
docs(markers): add docstrings to Marker.__and__/__or__ so they render in the API reference - #1274
Merged
Merged
Conversation
henryiii
approved these changes
Jun 20, 2026
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
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.
docs/markers.rstalready declares:special-members: __and__, __or__, but neither operator has a docstring. As a result Sphinx autodoc drops__and__from the rendered API Reference entirely, and renders__or__with the inheritedobject.__or__text ("Return self|value."), which describes bitwise-or rather than marker combination.Both operators shipped in 26.1 (#1146). This adds a short docstring carrying
.. versionadded:: 26.1to each so they render correctly in the Reference.Docstring-only; no behavior change. Refs #1239.