Skip to content

Adding fastpath and name parameters to docstring for Series class and others. #27235

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

Closed
wants to merge 7 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 2 additions & 0 deletions pandas/core/arrays/categorical.py
Original file line number Diff line number Diff line change
Expand Up @@ -267,6 +267,8 @@ class Categorical(ExtensionArray, PandasObject):
An instance of ``CategoricalDtype`` to use for this categorical

.. versionadded:: 0.21.0
fastpath : bool, default False
Internal use only

Attributes
----------
Expand Down
3 changes: 2 additions & 1 deletion pandas/core/groupby/grouper.py
Original file line number Diff line number Diff line change
Expand Up @@ -225,7 +225,8 @@ class Grouping:
index : Index
grouper :
obj :
name :
name : object, default None
Name to be stored in the Grouping
level :
observed : boolean, default False
If we are a Categorical, use the observed values
Expand Down
2 changes: 2 additions & 0 deletions pandas/core/indexes/base.py
Original file line number Diff line number Diff line change
Expand Up @@ -207,6 +207,8 @@ class Index(IndexOpsMixin, PandasObject):
Make a copy of input ndarray
name : object
Name to be stored in the index
fastpath : bool, default None
Internal use only
tupleize_cols : bool (default: True)
When True, attempt to create a MultiIndex if possible

Expand Down
2 changes: 2 additions & 0 deletions pandas/core/indexes/category.py
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,8 @@ class CategoricalIndex(Index, accessor.PandasDelegate):
Make a copy of input ndarray.
name : object, optional
Name to be stored in the index.
fastpath : bool, default None
Internal use only

Attributes
----------
Expand Down
2 changes: 2 additions & 0 deletions pandas/core/indexes/multi.py
Original file line number Diff line number Diff line change
Expand Up @@ -157,6 +157,8 @@ class MultiIndex(Index):
Names for each of the index levels. (name is accepted for compat).
copy : bool, default False
Copy the meta-data.
name : object, default None
Name to be stored in the index
verify_integrity : bool, default True
Check that the levels/codes are consistent and valid.

Expand Down
2 changes: 2 additions & 0 deletions pandas/core/indexes/period.py
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,8 @@ class PeriodIndex(DatetimeIndexOpsMixin, Int64Index, PeriodDelegateMixin):
tz : object, default None
Timezone for converting datetime64 data to Periods
dtype : str or PeriodDtype, default None
name : object, default None
Name to be stored in the index

Attributes
----------
Expand Down
2 changes: 2 additions & 0 deletions pandas/core/indexes/range.py
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,8 @@ class RangeIndex(Int64Index):
Name to be stored in the index
copy : bool, default False
Unused, accepted for homogeneity with other index types.
fastpath : bool, default None
Internal use only

Attributes
----------
Expand Down
4 changes: 4 additions & 0 deletions pandas/core/series.py
Original file line number Diff line number Diff line change
Expand Up @@ -168,8 +168,12 @@ class Series(base.IndexOpsMixin, generic.NDFrame):
Data type for the output Series. If not specified, this will be
inferred from `data`.
See the :ref:`user guide <basics.dtypes>` for more usages.
name : object, default None
Name to be stored in the Series
copy : bool, default False
Copy input data.
fastpath : bool, default False
Internal use only
"""

_metadata = ["name"]
Expand Down