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

Allow named sections after numpy examples #54

Merged
merged 2 commits into from
Feb 26, 2022

Conversation

FasterSpeeding
Copy link
Contributor

This is an attempt at fixing the current behaviour where numpydoc Examples sections would erroneously include the content of any following named sections until they reach an unnamed section or the end of the docstring.

@FasterSpeeding FasterSpeeding force-pushed the bugfix/numpy-examples branch 3 times, most recently from 8674ec9 to 69b6df6 Compare February 24, 2022 07:50
Copy link
Member

@pawamoy pawamoy left a comment

Choose a reason for hiding this comment

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

Nice, thanks! Could you simplify the test by reducing the size of the examples section, and by actually testing that first section is examples and second section is parameters? No need to check the examples section contents.

@FasterSpeeding
Copy link
Contributor Author

Nice, thanks! Could you simplify the test by reducing the size of the examples section, and by actually testing that first section is examples and second section is parameters? No need to check the examples section contents.

Have updated the test 👍

@FasterSpeeding FasterSpeeding force-pushed the bugfix/numpy-examples branch 2 times, most recently from 3cc9428 to 5ed8db1 Compare February 25, 2022 08:20
@pawamoy
Copy link
Member

pawamoy commented Feb 26, 2022

Thank you for updating the PR, I had to fix the tests because they were racing 😅 Sorry for the extra work.

@pawamoy
Copy link
Member

pawamoy commented Feb 26, 2022

OK, LGTM (failures in CI are irrelevant to this PR). Thanks again!

@pawamoy pawamoy merged commit 3d9f131 into mkdocstrings:master Feb 26, 2022
@FasterSpeeding
Copy link
Contributor Author

Thank you for updating the PR, I had to fix the tests because they were racing 😅 Sorry for the extra work.

Np, just glad i could help 😄

pawamoy pushed a commit that referenced this pull request Mar 1, 2022
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.

2 participants