Skip to content

DOC: Added maximum_sctype to documentation #13054

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.

Sign up for GitHub

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 1 commit into from
Feb 27, 2019
Merged

DOC: Added maximum_sctype to documentation #13054

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions doc/source/reference/routines.dtype.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,9 @@ Data type routines

Creating data types
-------------------

.. autosummary::
:toctree: generated/


dtype
format_parser

Expand Down Expand Up @@ -53,3 +51,4 @@ Miscellaneous
typename
sctype2char
mintypecode
maximum_sctype
1 change: 1 addition & 0 deletions numpy/core/numerictypes.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,6 +140,7 @@
'complex32', 'complex64', 'complex128', 'complex160',
'complex192', 'complex256', 'complex512', 'object']

@set_module('numpy')
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added for consistency with all the other exported functions in the module

def maximum_sctype(t):
"""
Return the scalar type of highest precision of the same kind as the input.
Expand Down
1 change: 0 additions & 1 deletion numpy/tests/test_public_api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,6 @@ def test_numpy_namespace():
'get_include': 'numpy.lib.utils.get_include',
'int_asbuffer': 'numpy.core._multiarray_umath.int_asbuffer',
'mafromtxt': 'numpy.lib.npyio.mafromtxt',
'maximum_sctype': 'numpy.core.numerictypes.maximum_sctype',
'ndfromtxt': 'numpy.lib.npyio.ndfromtxt',
'recfromcsv': 'numpy.lib.npyio.recfromcsv',
'recfromtxt': 'numpy.lib.npyio.recfromtxt',
Expand Down