DOC: Added example to MultiIndex doc string #17653
Conversation
topper-123
force-pushed
the
multiindex_examples
branch
from
4692b39 to
b7bd41d
Compare
topper-123
changed the title
pandas/core/indexes/multi.py
Outdated
| DataFrame, e.g.: | ||
|
|
||
| >>> pd.Series([1, 2, 3, 4], index=mi) | ||
|
|
There was a problem hiding this comment.
actually adding a See Also section would be good (as then links are generated)
pandas/core/indexes/multi.py
Outdated
| >>> mi = MultiIndex.from_arrays(arrays, names=('number', 'color')) | ||
| >>> mi | ||
|
|
||
| Such a ``MultiIndex`` instance can be used as an index in a Series or |
There was a problem hiding this comment.
this last part is not really relevant
you can certainly link to a MI (and Index) from Series / DataFrame constructor though
topper-123
force-pushed
the
multiindex_examples
branch
from
b7bd41d to
0c36dc1
Compare
Codecov Report
@@ Coverage Diff @@
## master #17653 +/- ##
==========================================
- Coverage 91.26% 91.24% -0.02%
==========================================
Files 163 163
Lines 49776 49776
==========================================
- Hits 45426 45417 -9
- Misses 4350 4359 +9
Continue to review full report at Codecov.
|
Codecov Report
@@ Coverage Diff @@
## master #17653 +/- ##
==========================================
- Coverage 91.26% 91.24% -0.02%
==========================================
Files 163 163
Lines 49806 49806
==========================================
- Hits 45455 45446 -9
- Misses 4351 4360 +9
Continue to review full report at Codecov.
|
topper-123
force-pushed
the
multiindex_examples
branch
2 times, most recently
from
fa1ecb6 to
eea2e7e
Compare
|
I've made changes. In addition, I've also added a |
pandas/core/indexes/multi.py
Outdated
|
|
||
| Notes | ||
| ----- | ||
| See the :ref:`user guide <advanced>` for more. |
There was a problem hiding this comment.
I think you have to put the full http link here (technically you don't for the built docs), but in a console this won't work.
topper-123
force-pushed
the
multiindex_examples
branch
from
eea2e7e to
26d8bd2
Compare
|
Hello @topper-123! Thanks for updating the PR. Cheers ! There are no PEP8 issues in this Pull Request. 🍻 Comment last updated on September 25, 2017 at 08:12 Hours UTC |
topper-123
force-pushed
the
multiindex_examples
branch
2 times, most recently
from
a788612 to
517f4b6
Compare
pandas/core/indexes/multi.py
Outdated
| See the `user guide | ||
| <http://pandas.pydata.org/pandas-docs/stable/advanced.html>`_ for more. | ||
|
|
||
| See also |
pandas/core/indexes/multi.py
Outdated
| Examples | ||
| --------- | ||
| A new ``MultiIndex`` is typically constructed using one of the helper | ||
| methods :attr:`MultiIndex.from_arrays``, :attr:`MultiIndex.from_product`` |
topper-123
force-pushed
the
multiindex_examples
branch
from
517f4b6 to
eccb594
Compare
topper-123
force-pushed
the
multiindex_examples
branch
from
eccb594 to
a796a37
Compare
|
@topper-123 Thanks! It's really nice to see all those doc improvements! |
git diff upstream/master -u -- "*.py" | flake8 --diffI think
MultiIndexdoc string should have a quick note on howMultiIndexis typically instantiated, as you normally wouldn't instantiate it directly.I've added an example to the doc string, as in my experience
MultiIndexis one of the more complex areas of Pandas, so a quick example is justified. This may be debatable, so if others disagree on having an example here, I can remove the example and just retain the links to the.from_*methods.