-
-
Notifications
You must be signed in to change notification settings - Fork 18.7k
DOC: improved the docstring of pandas.Index.min() #20140
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
Changes from 8 commits
1802ae4
752f385
fdaee80
c44accd
12cfd8d
dfd389d
4bc62e6
2ce2921
e717374
49a6e08
4e8e937
b437afd
e47f59f
d3b3398
9bf1cae
fe581ba
b5fc47b
4ea4351
ace5676
5c00e65
c7887cc
4896e0b
7d65b9e
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -801,7 +801,31 @@ def argmax(self, axis=None): | |
return nanops.nanargmax(self.values) | ||
|
||
def min(self): | ||
""" The minimum value of the object """ | ||
""" | ||
Return the minimum value of the Index object. | ||
|
||
Return the minimum value of the object within the same type. | ||
The Index of a DataFrame can be accessed as pandas.DataFrame.index. | ||
|
||
Returns | ||
------- | ||
scalar or object | ||
minimum value | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Sorry, perhaps I wasn't clear before.
I'll quote the docs:
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think now should be fine, thanks! |
||
|
||
See Also | ||
-------- | ||
Index.max : Return the maximum value of the object. | ||
|
||
Examples | ||
-------- | ||
>>> idx = pd.Index([3, 2, 1]) | ||
>>> idx.min() | ||
1 | ||
|
||
>>> idx = pd.Index(['c', 'b', 'a']) | ||
>>> idx.min() | ||
'a' | ||
""" | ||
return nanops.nanmin(self.values) | ||
|
||
def argmin(self, axis=None): | ||
|
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.
The description must start with a capital letter, and finish with a dot.