Changed docstrings in Text #11513
Merged
Changed docstrings in Text #11513
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
NelleV
reviewed
Jun 26, 2018
| Returns True or False. | ||
| Returns | ||
| ------- | ||
| bool : bool |
There was a problem hiding this comment.
with returns, you don't necessarily have to use this syntax. You could also write:
Returns
-------
bool
There was a problem hiding this comment.
You can but it often looks ugly, because it get bold and not formatted like for example here.
I am not sure if it is a bug in numpydocs because the documentation says that the return name is optional but the type is rendered as a name (bold) when the name is omitted.
NelleV
reviewed
Jun 26, 2018
|
|
||
| Parameters | ||
| ---------- | ||
| rectprops : FancyBboxPatch prop dict | ||
| rectprops : dict with properties for `.patches.FancyBboxPatch` |
NelleV
approved these changes
Jun 26, 2018
|
Thanks @fredrik-1 ! |
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.
It was still a small problem with Text aliases.
fontnameis just a one way alias offontfamilyand the options forfontnamedissapeared in the kwarg list. This pr make bothfontnameandfontfamilyappear in the kwarg lists with accepted values and the information about the alias behavior are in the docstrings.I also went through the docstrings and changed some formatting.