-
-
Notifications
You must be signed in to change notification settings - Fork 17.9k
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
DOC: Fixed the doctsring for _set_axis_name (GH 22895) #22969
Changes from 4 commits
a5fd1c3
5dbbbd1
bc865d4
457c58e
e469e4e
7fb8a52
067fa8d
71f3909
a7eb3d8
96a5dd1
22ef507
b030a6b
6d76d44
adc2694
9d944e8
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -1194,31 +1194,35 @@ def rename_axis(self, mapper, axis=0, copy=True, inplace=False): | |
|
||
def _set_axis_name(self, name, axis=0, inplace=False): | ||
""" | ||
Alter the name or names of the axis. | ||
Alter the label(s) of the axis. | ||
|
||
Parameters | ||
---------- | ||
name : str or list of str | ||
Name for the Index, or list of names for the MultiIndex | ||
axis : int or str | ||
0 or 'index' for the index; 1 or 'columns' for the columns | ||
inplace : bool | ||
whether to modify `self` directly or return a copy | ||
Labels(s) to set. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Same as before, label is the names of each individual column, not the name of the axis |
||
axis : int or str, default 0 | ||
The axis to set the label. The value 0 or 'index' specifies index, | ||
datapythonista marked this conversation as resolved.
Show resolved
Hide resolved
|
||
and the value 1 or 'columns' specifies columns. | ||
inplace : bool, default False | ||
Whether to modify `self` directly or return a copy. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. see what we use elsewhere for this There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. There isn't great consistency for the description of |
||
|
||
.. versionadded:: 0.21.0 | ||
|
||
Returns | ||
------- | ||
renamed : same type as caller or None if inplace=True | ||
Series, DataFrame, Panel, or None | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Can you remove |
||
The same type as the caller or `None` if `inplace` is `True`. | ||
|
||
See Also | ||
-------- | ||
pandas.DataFrame.rename | ||
pandas.Series.rename | ||
pandas.Index.rename | ||
pandas.DataFrame.rename : Alter the labels of :class:`DataFrame`. | ||
pandas.Series.rename : Alter the name or the labels :class:`Series`. | ||
pandas.Index.rename : Alter the name of :class:`Index` | ||
or :class:`MultiIndex`. | ||
|
||
Examples | ||
-------- | ||
>>> df = pd.DataFrame({"A": [1, 2, 3]}) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Thanks for updating the docstring @bkjchoi72, looking much better now, and it fixes the doctest, which was the main goal. Just one comment that would make this docstring even better, besides the comments in the previous review. Do you mind adding a more real-world example? I know it's the original example, not yours, but setting the axis name to We use examples in the code with names of animals, and some property like the number of legs. Could you do something like that, and set the axis to If you can also change that in There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Thanks for the suggestion. I'll make those changes. |
||
>>> df._set_axis_name("foo") | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. can you show what the current axis name is prior to setting it. |
||
A | ||
foo | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This doesn't seem correct. Altering the labels would be changing the names of the columns, not the name of the axis itself.
And small thing, but alter doesn't necessarily need to be correct. If the axis doesn't have a name, it's setting it, but not altering.
Set
would be better I think.