Skip to content

docs: merge __init__/__new__ docstrings into class docstrings - #1623

Closed
Solaris-star wants to merge 1 commit into
collective:mainfrom
Solaris-star:fix/1620-merge-init-docstrings
Closed

docs: merge __init__/__new__ docstrings into class docstrings#1623
Solaris-star wants to merge 1 commit into
collective:mainfrom
Solaris-star:fix/1620-merge-init-docstrings

Conversation

@Solaris-star

Copy link
Copy Markdown
Contributor

Moves all constructor documentation from __init__/__new__ methods into their class docstrings so Sphinx renders them correctly with autoclass_content = 'class'.

  • 17 methods migrated across 14 files
  • Added test_no_init_docstrings.py — fails if any __init__/__new__ carries a docstring
  • 14085 existing tests pass

Closes #1620

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
@github-actions

github-actions Bot commented Aug 1, 2026

Copy link
Copy Markdown
Contributor

Profile summary:

GitHub user: Solaris-star
🟡 Some concerns found with user's profile.
🟡 Some concerns found with recent PR activity.
🟢 No concerns found with recent issue activity.

For a more detailed report, run `gh-profiler Solaris-star`.
Full profile
GitHub user: Solaris-star
🟡 Some concerns found with user's profile.
   🟢 Account age: 6 years
   🟡 Profile information:
        company: University of Bristol
        location: China
      Empty fields: name, blog, email, bio

🟡 Some concerns found with recent PR activity.
   100 PRs opened in the last 21 days.
      10 opened against repos the user owns.
      0 opened against repos in publicly associated orgs.
      90 opened against external repos.

   🟡 32 of 90 external PRs closed without merging in the last 21 days.

🟢 No concerns found with recent issue activity.
   2 new issues opened in the last 21 days.
      0 opened in repos the user owns.
      0 opened in repos in publicly associated orgs.
      2 opened in external repos.

   🟢 0 external issues closed as NOT_PLANNED.
   🟢 0 external issues opened with the same title.

@github-actions github-actions Bot added the ai-suspicion This contribution is possibly created with lots of AI help without enough human understanding. label Aug 1, 2026
@github-actions

github-actions Bot commented Aug 1, 2026

Copy link
Copy Markdown
Contributor

This pull request did not pass quality checks and AI use is suspected. Please review Contribute and make any necessary amendments.

@stevepiercy

Copy link
Copy Markdown
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.

@Solaris-star

Copy link
Copy Markdown
Contributor Author

Understood — closing this in favour of #1622. I'll go review that PR instead. Thanks for the heads up!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ai-suspicion This contribution is possibly created with lots of AI help without enough human understanding.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Merge __init__ or __new__ docstrings into their class's docstring

2 participants