Fix Boxplot docs to conform to numpydoc #6240
Closed
+22
−18
Conversation
This file contains hidden or 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
Member
jenshnielsen
commented
Mar 29, 2016
- Additional Options is not a valid numpy doc section so this whole section gets dropped here I have converted this to Other Parameters which is valid.
- The section below does not confirm to numpy doc so I have converted the parameters to numpydoc format. This makes it slightly more verbose but renders correctly. I could be convinced to drop this if needed.
|
These docstrings should probably exactly match the docs of |
|
Makes sense. Have we decided on a standard for documenting optional parameters and default values. boxplot and bxp does it in two different ways. |
|
@jenshnielsen Can you re-open this against 2.x or master? |
|
@jenshnielsen was this ever re-opened? |
NelleV
added a commit
that referenced
this pull request
Oct 16, 2016
Fix Boxplot docs to conform to numpydoc (rebase #6240)
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.