Skip to content

Remove _InheritDocstrings#2049

Merged
sydduckworth merged 2 commits into
asdf-format:mainfrom
sydduckworth:remove-inherit-docstrings
May 13, 2026
Merged

Remove _InheritDocstrings#2049
sydduckworth merged 2 commits into
asdf-format:mainfrom
sydduckworth:remove-inherit-docstrings

Conversation

@sydduckworth
Copy link
Copy Markdown
Contributor

@sydduckworth sydduckworth commented May 13, 2026

Description

  • Removed _InheritDocstrings metaclass

_InheritDocstrings seems unnecessary because its intended behavior is already built in to Sphinx (and other docs generators).
Additionally it will overwrite the docstring of a child method with the parent docstring even if the child is already documented, which doesn't seem like desired behavior.

This PR produces no changes in the public API documentation.

@sydduckworth sydduckworth force-pushed the remove-inherit-docstrings branch from 3074b5f to be273df Compare May 13, 2026 13:44
@sydduckworth sydduckworth marked this pull request as ready for review May 13, 2026 13:48
@sydduckworth sydduckworth requested a review from a team as a code owner May 13, 2026 13:48
@sydduckworth sydduckworth requested a review from braingram May 13, 2026 13:48
Copy link
Copy Markdown
Contributor

@braingram braingram left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@sydduckworth sydduckworth enabled auto-merge May 13, 2026 15:29
@sydduckworth sydduckworth merged commit 90e2874 into asdf-format:main May 13, 2026
42 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants