DOC: Added maximum_sctype to documentation #13054
Merged
+2
−3
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
madphysicist
commented
Feb 27, 2019
| @@ -140,6 +140,7 @@ | |||
| 'complex32', 'complex64', 'complex128', 'complex160', | |||
| 'complex192', 'complex256', 'complex512', 'object'] | |||
|
|
|||
| @set_module('numpy') | |||
There was a problem hiding this comment.
Added for consistency with all the other exported functions in the module
c6dad91 to
194927d
Compare
|
I finally figured out how to build the docs properly. Looks like the change did in fact work. |
|
LGTM, thanks @madphysicist |
|
@mattip. Thanks. That was very fast. |
11 tasks
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.
maximum_sctypeis probably OK to be in the docs since it is referenced in multiple places, e.g.:I have attempted to fix the non-generation of the doc by adding it to the autodoc page under https://docs.scipy.org/doc/numpy/reference/routines.dtype.html, and removing it from the undocumented list.
The issue originally came up in https://stackoverflow.com/a/48412971/2988730