Skip to content

Commit 8accbaf

Browse files
KeiOshimakvnwng
authored and
kvnwng
committed
DOC: fixing SA01 errors for Index: name, dtype, and equals (pandas-dev#58355)
* DOC: fixing SA01 errors for Index: name, dtype, and equals * fixing Blank line contains whitespace error
1 parent 9766248 commit 8accbaf

File tree

2 files changed

+15
-3
lines changed

2 files changed

+15
-3
lines changed

ci/code_checks.sh

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -136,10 +136,8 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
136136
-i "pandas.Index.drop_duplicates RT03" \
137137
-i "pandas.Index.droplevel RT03,SA01" \
138138
-i "pandas.Index.dropna RT03,SA01" \
139-
-i "pandas.Index.dtype SA01" \
140139
-i "pandas.Index.duplicated RT03" \
141140
-i "pandas.Index.empty GL08" \
142-
-i "pandas.Index.equals SA01" \
143141
-i "pandas.Index.fillna RT03" \
144142
-i "pandas.Index.get_indexer PR07,SA01" \
145143
-i "pandas.Index.get_indexer_for PR01,SA01" \
@@ -153,7 +151,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
153151
-i "pandas.Index.item SA01" \
154152
-i "pandas.Index.join PR07,RT03,SA01" \
155153
-i "pandas.Index.memory_usage RT03" \
156-
-i "pandas.Index.name SA01" \
157154
-i "pandas.Index.names GL08" \
158155
-i "pandas.Index.nunique RT03" \
159156
-i "pandas.Index.putmask PR01,RT03" \

pandas/core/indexes/base.py

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -976,6 +976,10 @@ def dtype(self) -> DtypeObj:
976976
"""
977977
Return the dtype object of the underlying data.
978978
979+
See Also
980+
--------
981+
Index.inferred_type: Return a string of the type inferred from the values.
982+
979983
Examples
980984
--------
981985
>>> idx = pd.Index([1, 2, 3])
@@ -1638,6 +1642,11 @@ def name(self) -> Hashable:
16381642
"""
16391643
Return Index or MultiIndex name.
16401644
1645+
See Also
1646+
--------
1647+
Index.set_names: Able to set new names partially and by level.
1648+
Index.rename: Able to set new names partially and by level.
1649+
16411650
Examples
16421651
--------
16431652
>>> idx = pd.Index([1, 2, 3], name="x")
@@ -5181,6 +5190,12 @@ def equals(self, other: Any) -> bool:
51815190
True if "other" is an Index and it has the same elements and order
51825191
as the calling index; False otherwise.
51835192
5193+
See Also
5194+
--------
5195+
Index.identical: Checks that object attributes and types are also equal.
5196+
Index.has_duplicates: Check if the Index has duplicate values.
5197+
Index.is_unique: Return if the index has unique values.
5198+
51845199
Examples
51855200
--------
51865201
>>> idx1 = pd.Index([1, 2, 3])

0 commit comments

Comments
 (0)