Skip to content

DOC add example of Series.index #51842

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

Merged
merged 27 commits into from
Apr 16, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
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
1 change: 0 additions & 1 deletion ci/code_checks.sh
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then

MSG='Partially validate docstrings (EX01)' ; echo $MSG
$BASE_DIR/scripts/validate_docstrings.py --format=actions --errors=EX01 --ignore_functions \
pandas.Series.index \
pandas.Series.__iter__ \
pandas.Series.keys \
pandas.Series.item \
Expand Down
41 changes: 40 additions & 1 deletion pandas/core/series.py
Original file line number Diff line number Diff line change
Expand Up @@ -5745,7 +5745,46 @@ def to_period(self, freq: str | None = None, copy: bool | None = None) -> Series
_info_axis_name: Literal["index"] = "index"

index = properties.AxisProperty(
axis=0, doc="The index (axis labels) of the Series."
axis=0,
doc="""
The index (axis labels) of the Series.

The index of a Series is used to label and identify each element of the
underlying data. The index can be thought of as an immutable ordered set
(technically a multi-set, as it may contain duplicate labels), and is
used to index and align data in pandas.

Returns
-------
Index
The index labels of the Series.

See Also
--------
Series.reindex : Conform Series to new index.
Series.set_index : Set Series as DataFrame index.
Index : The base pandas index type.

Notes
-----
For more information on pandas indexing, see the `indexing user guide
<https://pandas.pydata.org/docs/user_guide/indexing.html>`__.

Examples
--------
To create a Series with a custom index and view the index labels:

>>> cities = ['Kolkata', 'Chicago', 'Toronto', 'Lisbon']
>>> populations = [14.85, 2.71, 2.93, 0.51]
>>> city_series = pd.Series(populations, index=cities)
>>> city_series.index
Index(['Kolkata', 'Chicago', 'Toronto', 'Lisbon'], dtype='object')

To change the index labels of an existing Series:
>>> city_series.index = ['KOL', 'CHI', 'TOR', 'LIS']
>>> city_series.index
Index(['KOL', 'CHI', 'TOR', 'LIS'], dtype='object')
""",
)

# ----------------------------------------------------------------------
Expand Down