Skip to content

DOC: Enforce Numpy Docstring Validation for pandas.Index.names #58563

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

Merged
merged 4 commits into from
May 5, 2024
Merged

DOC: Enforce Numpy Docstring Validation for pandas.Index.names #58563

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5d8684f
DOC: add GL08 for pandas.Index.names
tuhinsharma121 May 4, 2024
27ecfe0
DOC: remove GL08 for pandas.Index.names
tuhinsharma121 May 4, 2024
4eee2ab
Merge remote-tracking branch 'upstream/main' into np-doc-index-names
tuhinsharma121 May 5, 2024
d11ca3e
DOC: change return type to FrozenList in example
tuhinsharma121 May 5, 2024
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
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i "pandas.Grouper PR02" \
-i "pandas.Index PR07" \
-i "pandas.Index.join PR07,RT03,SA01" \
-i "pandas.Index.names GL08" \
-i "pandas.Index.ravel PR01,RT03" \
-i "pandas.Index.str PR01,SA01" \
-i "pandas.Interval PR02" \
Expand Down
17 changes: 17 additions & 0 deletions pandas/core/indexes/base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1799,6 +1799,23 @@ def _get_default_index_names(
return names

def _get_names(self) -> FrozenList:
"""
Get names on index.

See Also
--------
Index.name : Return Index or MultiIndex name.

Examples
--------
>>> idx = pd.Index([1, 2, 3], name="x")
>>> idx.names
FrozenList(['x'])

>>> idx = s = pd.Index([1, 2, 3], name=("x", "y"))
>>> idx.names
FrozenList([('x', 'y')])
"""
return FrozenList((self.name,))

def _set_names(self, values, *, level=None) -> None:
Expand Down
Loading