docs: Fix and complete numpydoc Parameters sections - #435
Merged
tlambert03 merged 8 commits intoSep 13, 2026
Merged
Conversation
tlambert03
reviewed
Sep 13, 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.
Summary
Fixes and completes numpydoc
Parameterssections in the container and event APIs:connect_child_events: the section header was written asParameters.(with atrailing period), which numpydoc does not recognize, so the parameter list below it
was rendered as plain text.
qt.stop_emitting_from_queue: the parameter list (thread) had noParametersheader at all.
SelectableEventedList.select_previous:select_nextright above it documentsexpand_selectionandwraparound;select_previoustakes the same arguments buthad no section. The new section mirrors the existing one.
SelectableEventedList.insert,EventedList.reverse,SignalRelay.block, andSelectable.selection: their parameters were not described.All existing sentences are preserved verbatim; only sections are added, so no
behaviour or signatures change. These docstrings are rendered on the docs site with
docstring_style: numpy, so the two header fixes directly affect the rendered APIreference (the previously broken lists are currently shown as plain text).
Testing
python -m py_compilepasses on all touched filesD417-consistent), andthe section headers follow the existing
Parameters/----------pattern usedelsewhere in the codebase
This contribution was prepared with AI assistance (a local LLM-based agent harness with deterministic checks and human review).