This repository has been archived by the owner on Nov 3, 2021. It is now read-only.
WIP: Use Numpy style docstrings #1534
Open
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
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Note: it is not intended to be merged as it is neither a place to discuss if we want to use numpy style.
This is just to demonstrate the possibilities of the pyment tool. It could help us if we eventually decide to switch from pure rst to google or numpy styles.
After migrating the whole codebase using this command:
pyment -o numpydoc -w src/sardanathere were few modules with wrongly indented docstings (one per file). Not a big deal to manually fix this.Also, the sphinx build shows 102 warnings.