Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docstring cleanups #181

Merged
merged 4 commits into from
Oct 4, 2023
Merged

Docstring cleanups #181

merged 4 commits into from
Oct 4, 2023

Conversation

jnikula
Copy link
Owner

@jnikula jnikula commented Oct 3, 2023

Some docstring code cleanups

Do not rely on having the blank lines in _fmt.
Also move RootDocstring after _CompoundDocstring.
Anything that has children should be a subclass of _CompoundDocstring.
Only _CompoundDocstring and its subclasses can have children.
@jnikula
Copy link
Owner Author

jnikula commented Oct 4, 2023

Rebased to pass documentation check.

Copy link
Collaborator

@BrunoMSantos BrunoMSantos left a comment

Choose a reason for hiding this comment

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

Yup, looks good!

src/hawkmoth/docstring.py Show resolved Hide resolved
@jnikula jnikula merged commit cd9f3af into master Oct 4, 2023
4 checks passed
@jnikula jnikula deleted the docstring-cleanups branch October 4, 2023 08:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants