DOC: improved the docstring of pandas.Index.min() #20140
Conversation
juanhuguetgarcia
changed the title
pandas/core/base.py
Outdated
| """ | ||
| Return the minimum value of the Index object. | ||
|
|
||
| Return the maximum value of the object within the same type. |
|
Looks fine, as index.max ;) |
pandas/core/base.py
Outdated
| Returns | ||
| ------- | ||
| scalar or object | ||
| minimum value |
There was a problem hiding this comment.
The description must start with a capital letter, and finish with a dot.
…a/pandas into pandas.index.min
|
Hello @juanhuguetgarcia! Thanks for updating the PR. Cheers ! There are no PEP8 issues in this Pull Request. 🍻 Comment last updated on March 16, 2018 at 21:15 Hours UTC |
pandas/core/base.py
Outdated
| Returns | ||
| ------- | ||
| Scalar or object. | ||
| minimum value |
There was a problem hiding this comment.
Sorry, perhaps I wasn't clear before.
scalar or object
Minimum value.
I'll quote the docs:
The documentation of the return is also similar to the parameters. But in this case, no name will be provided, unless the method returns or yields more than one value (a tuple of values).
The parameters are defined by their name, followed by a space, a colon, another space, and the type (or types). Note that the space between the name and the colon is important. Types are not defined for *args and **kwargs, but must be defined for all other parameters. After the parameter definition, it is required to have a line with the parameter description, which is indented, and can have multiple lines. The description must start with a capital letter, and finish with a dot.
There was a problem hiding this comment.
I think now should be fine, thanks!
[ci skip]
Codecov Report
@@ Coverage Diff @@
## master #20140 +/- ##
==========================================
- Coverage 91.72% 91.7% -0.03%
==========================================
Files 150 150
Lines 49156 49152 -4
==========================================
- Hits 45090 45074 -16
- Misses 4066 4078 +12
Continue to review full report at Codecov.
|
[ci skip]
|
Thanks everyone! |
Checklist for the pandas documentation sprint (ignore this if you are doing
an unrelated PR):
scripts/validate_docstrings.py <your-function-or-method>git diff upstream/master -u -- "*.py" | flake8 --diffpython doc/make.py --single <your-function-or-method>Please include the output of the validation script below between the "```" ticks:
If the validation script still gives errors, but you think there is a good reason
to deviate in this case (and there are certainly such cases), please state this
explicitly.