Skip to content

Documented and standardize "private" or "internal use only" methods w… - #2153

Open
stevepiercy wants to merge 6 commits into
mainfrom
1711-doc-private-objects
Open

stevepiercy wants to merge 6 commits into
mainfrom
1711-doc-private-objects

Conversation

@stevepiercy

@stevepiercy stevepiercy commented Nov 19, 2026 •

Copy link
Copy Markdown
Member

…ith Sphinx :meta private: field flag.

Linked issue

Closes #1711

Description

  • If a private method already had a docstring, inserted the flag. Else did nothing.
  • If an __init__ method contained docstrings, merged it with its class.
  • Added missing Parameters section as needed.
  • Added "Required." flag as needed.
  • Sorted parameters as needed.

Blocked by:

…ith Sphinx ``:meta private:`` field flag.

- If a private method already had a docstring, inserted the flag. Else did nothing.
- If an ``__init__`` method contained docstrings, merged it with its class.
- Added missing Parameters section as needed.
- Added "Required." flag as needed.
- Sorted parameters as needed.

Closes #1711
@github-actions

Copy link
Copy Markdown
Contributor

Thanks for the pull request, @stevepiercy! A maintainer will review it shortly.

@stevepiercy stevepiercy added this to the 8.0.0 milestone Nov 19, 2026
@stevepiercy
stevepiercy marked this pull request as draft November 19, 2026 07:06
@stevepiercy stevepiercy self-assigned this Nov 20, 2026
@stevepiercy stevepiercy added doc exempt Exempt from pull request quality check workflow labels Nov 20, 2026
@stevepiercy
stevepiercy marked this pull request as ready for review November 20, 2026 13:01
@stevepiercy
stevepiercy enabled auto-merge (squash) November 20, 2026 13:02

This branch has not been deployed

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

Labels

doc exempt Exempt from pull request quality check workflow

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Doc: how to handle "private" objects in docstrings and news fragments

1 participant