DOC: Documentation for pandas.core.indexes.api #22980
Merged
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
|
Hello @araraonline! Thanks for submitting the PR.
|
jreback
requested changes
Oct 4, 2018
Codecov Report
@@ Coverage Diff @@
## master #22980 +/- ##
==========================================
+ Coverage 92.19% 92.19% +<.01%
==========================================
Files 169 169
Lines 50911 50922 +11
==========================================
+ Hits 46939 46950 +11
Misses 3972 3972
Continue to review full report at Codecov.
|
lowerthansound
force-pushed
the
indexapi-document
branch
3 times, most recently
from
19df70c to
e55f9b3
Compare
lowerthansound
commented
Oct 5, 2018
pandas/core/indexes/api.py
Outdated
|
|
||
| Parameters | ||
| ---------- | ||
| indexes: a list of Index or array-like objects |
There was a problem hiding this comment.
Actually, this should be 'a list of Index or list objects'
Will fix soon
lowerthansound
force-pushed
the
indexapi-document
branch
from
e55f9b3 to
2e30318
Compare
jreback
approved these changes
Oct 6, 2018
|
context looks ok, @datapythonista or @jorisvandenbossche if you want to glance at the doc-strings; these are internal only |
datapythonista
requested changes
Oct 9, 2018
There was a problem hiding this comment.
Looks good, it's nice to have docs in those functions.
Few comments about formatting that apply to all docstrings:
- Start he docstring in the next line of
""", not in the same - Missing space before colon in Parameters
param_name : type - Missing period at the end of the parameter descriptions, and the returns description.
- Use Python types for parameter types (or returns), for example
boolinstead ofboolean. And have just the type, for examplelist of boolinstead ofa list of bool
lowerthansound
commented
Oct 10, 2018
pandas/core/indexes/api.py
Outdated
|
|
||
| - [list, list, ...]: Return ([list, list, ...], 'list') | ||
| - [list, Index, ...]: Return _sanitize_and_check([Index, Index, ...]) | ||
| Lists are sorted and converted to Index |
There was a problem hiding this comment.
Will add period to this too
lowerthansound
commented
Oct 10, 2018
pandas/core/indexes/api.py
Outdated
| @@ -144,6 +229,21 @@ def _sanitize_and_check(indexes): | |||
|
|
|||
|
|
|||
| def _get_consensus_names(indexes): | |||
| """ | |||
| Give a consensus 'names' to indexes, | |||
lowerthansound
force-pushed
the
indexapi-document
branch
from
e5a54da to
62e7a3e
Compare
datapythonista
approved these changes
Nov 4, 2018
JustinZhengBC
pushed a commit
to JustinZhengBC/pandas
that referenced
this pull request
Nov 14, 2018
tm9k1
pushed a commit
to tm9k1/pandas
that referenced
this pull request
Nov 19, 2018
Pingviinituutti
pushed a commit
to Pingviinituutti/pandas
that referenced
this pull request
Feb 28, 2019
Pingviinituutti
pushed a commit
to Pingviinituutti/pandas
that referenced
this pull request
Feb 28, 2019
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.
The functions on pandas.core.indexes.api had almost no documentation. This is an attempt to explain them better and a progress towards #22915.