docs: merge __init__/__new__ docstrings into class docstrings - #1623
Closed
Solaris-star wants to merge 1 commit into
Closed
docs: merge __init__/__new__ docstrings into class docstrings#1623Solaris-star wants to merge 1 commit into
Solaris-star wants to merge 1 commit into
Conversation
Move all constructor documentation from __init__/__new__ methods into their class docstrings so Sphinx renders them correctly with autoclass_content = 'class'. Add a test that fails if any __init__/__new__ carries a docstring. 17 methods migrated across 14 files. Closes collective#1620
Solaris-star
requested review from
SashankBhamidi,
angatha,
niccokunzmann and
stevepiercy
as code owners
August 1, 2026 14:41
Contributor
|
Profile summary: Full profile |
Contributor
|
This pull request did not pass quality checks and AI use is suspected. Please review Contribute and make any necessary amendments. |
Documentation build overview
45 files changed ·
|
Member
|
@Solaris-star there is already another PR open, which I'm currently reviewing. #1622 I'd much rather have people review open PRs than create another PR for the same issue. |
Contributor
Author
|
Understood — closing this in favour of #1622. I'll go review that PR instead. Thanks for the heads up! |
5 tasks
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.
Moves all constructor documentation from
__init__/__new__methods into their class docstrings so Sphinx renders them correctly withautoclass_content = 'class'.test_no_init_docstrings.py— fails if any__init__/__new__carries a docstringCloses #1620