Inner section merging and special method option #31
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
This PR is looking great! Thank you for this. I hope to be able to review it soon. |
|
Looks like the build passed but the (duplicated?) statuses never made it to GitHub. Really looking forward to this PR! |
rsokl
approved these changes
May 25, 2020
|
@Boubsi @Zeitsperre |
Closed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hi,
here is my contribution to your nice package, with three new built-in styles allowing to merge inner sections of parent and child, as well as an option to include specials methods like init into the docstring merge process.
It is a answer to issues #25 and #30
I wrote new tests for those improvements, updated docstrings and the readme file. You can review it (i might have made some syntax mistakes, english is not my native language).
I didn't update the CHANGELOG file nor the version: I let you to do it.
I also fixed what seems to be a bug in the main init.py and tests you wrote for the numpy_napoleon style which didn't seem to respect the correct syntax (it seems to me that there is no "Extended Summary" section in the napoleon style).
Feel free to make any comment on things you would like me to change.
Cheers