Skip to content
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

Fill up the missing docs for Index/MultiIndex #1123

Merged
merged 1 commit into from
Dec 12, 2019
+30 −3
Merged

Fill up the missing docs for Index/MultiIndex #1123

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
33 changes: 30 additions & 3 deletions docs/source/reference/indexing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,18 @@ Properties
.. autosummary::
:toctree: api/

Index.is_monotonic
Index.is_monotonic_increasing
Index.is_monotonic_decreasing
Index.has_duplicates
Index.hasnans
Index.dtype
Index.shape
Index.name
Index.names
Index.ndim
Index.size
Index.nlevels
Index.empty
Index.T

Expand All @@ -32,6 +39,8 @@ Modifying and computations
.. autosummary::
:toctree: api/

Index.all
Index.any
Index.copy
Index.is_boolean
Index.is_categorical
Expand All @@ -42,6 +51,8 @@ Modifying and computations
Index.is_object
Index.min
Index.max
Index.rename
Index.unique
Index.value_counts

Missing Values
Expand All @@ -63,7 +74,12 @@ Conversion
Index.to_series
Index.to_numpy

.. _api.multiindex:
Time-specific operations
~~~~~~~~~~~~~~~~~~~~~~~~
.. autosummary::
:toctree: api/

Index.shift

Combining / joining / set operations
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand All @@ -79,6 +95,8 @@ Selecting

Index.isin

.. _api.multiindex:

MultiIndex
----------
.. autosummary::
Expand All @@ -91,17 +109,22 @@ MultiIndex Constructors
.. autosummary::
:toctree: api/

MultiIndex.from_arrays
MultiIndex.from_tuples

MultiIndex Properties
~~~~~~~~~~~~~~~~~~~~~
.. autosummary::
:toctree: api/

MultiIndex.has_duplicates
MultiIndex.hasnans
MultiIndex.shape
MultiIndex.names
MultiIndex.ndim
MultiIndex.empty
MultiIndex.T
MultiIndex.size
MultiIndex.nlevels
MultiIndex.levshape

Expand All @@ -110,6 +133,7 @@ MultiIndex Missing Values
.. autosummary::
:toctree: api/

MultiIndex.fillna
MultiIndex.dropna

MultiIndex Modifying and computations
Expand All @@ -118,6 +142,8 @@ MultiIndex Modifying and computations
:toctree: api/

MultiIndex.copy
MultiIndex.min
MultiIndex.max
MultiIndex.value_counts

MultiIndex Combining / joining / set operations
Expand All @@ -127,9 +153,10 @@ MultiIndex Combining / joining / set operations

MultiIndex.symmetric_difference

Conversion
~~~~~~~~~~
MultiIndex Conversion
~~~~~~~~~~~~~~~~~~~~~
.. autosummary::
:toctree: api/

MultiIndex.astype
MultiIndex.to_numpy