-
-
Notifications
You must be signed in to change notification settings - Fork 11k
ENH: Show full PEP 457 argument lists for ufuncs #9026
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
Merged
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
476ce74
DOC: Show full argument lists for ufuncs
eric-wieser ba6c1af
DOC: Refer to main ufunc docs for kwargs
eric-wieser bcc77f9
DOC: Remove explanation of exception due to out
eric-wieser 0025c86
DOC: Simplify the output of help(ufunc)
eric-wieser 2e32026
DOC: Correct parameter names for spacing and invert
eric-wieser File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Each of the
*
need escaping like so\\*
for sphinx. If you make it a raw string you can use a single\
.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This file never actually reaches sphinx anyway, but I was under the impression that this worked correctly due to the transformation that the
Parameters
section undergoesThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've had to fix other uses before as the docs didn't render correctly.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Well, this doesn't even get rendered, so no danger of it getting rendered incorrectly!
Since the only place this is ever seen is in the terminal, I'd argue it's better without backslashes.
I'd also argue that to keep the terminal tidy, the fix should go in the numpy sphinx extension, not here
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I agree that having numpydoc escape the
*
's when generating the sphinx input would be nice, but it doesn't at this time. If this never showed up in the documentation, that would not be a problem, but I assume you would like it to eventually show up.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not really - AFAICT, the sole purposed of this page is to redirect the user to
np.info
or the ufunc docs. ifufunc.__doc__
is made visible in the web docs, then IMO, it should be the contents ofufuncs.rst
.This docstring aside - I was pretty sure that
**kwargs
was parsed correctly in the other docstring modified by this changeset - does the issue only exist for single asterisks?