Skip to content

DOC: fix formatting in the ExtensionArray docstrings #28686

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 9 commits into from
Oct 14, 2019
Merged

DOC: fix formatting in the ExtensionArray docstrings #28686

Changes from 4 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
a0b1ae3
fix doc string for ExtensionArray.fillna issue #28685
HughKelley Sep 30, 2019
a0e5097
fix doc string return value description for ExtensionArray.fillna iss…
HughKelley Sep 30, 2019
8901b20
fix doc string formatting errors for ExtensionArray.view issue #28685
HughKelley Sep 30, 2019
32f9a21
fix doc string formatting errors for ExtensionArray.shift issue #28685
HughKelley Sep 30, 2019
c5e31fc
fix typos and formatting of method and class
HughKelley Oct 2, 2019
149ba48
Update with recent commits to master Merge branch 'master' into Exten…
HughKelley Oct 2, 2019
236dadb
update branch Merge remote-tracking branch 'upstream/master' into Ext…
HughKelley Oct 14, 2019
de80ceb
remove calling...
HughKelley Oct 14, 2019
357c50f
indentation
HughKelley Oct 14, 2019
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
15 changes: 9 additions & 6 deletions pandas/core/arrays/base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ class ExtensionArray:
"""
Abstract base class for custom 1-D array types.

pandas will recognize instances of this class as proper arrays
pandas will recognize instances of this claspandas.api.extensions.ExtensionArray.views as proper arrays
with a custom type and will not attempt to coerce them to objects. They
may be stored directly inside a :class:`DataFrame` or :class:`Series`.

Expand Down Expand Up @@ -474,7 +474,7 @@ def fillna(self, value=None, method=None, limit=None):
method : {'backfill', 'bfill', 'pad', 'ffill', None}, default None
Method to use for filling holes in reindexed Series
pad / ffill: propagate last valid observation forward to next valid
backfill / bfill: use NEXT valid observation to fill gap
backfill / bfill: use NEXT valid observation to fill gap.
limit : int, default None
If method is specified, this is the maximum number of consecutive
NaN values to forward/backward fill. In other words, if there is
Expand All @@ -485,7 +485,8 @@ def fillna(self, value=None, method=None, limit=None):

Returns
-------
filled : ExtensionArray with NA/NaN filled
ExtensionArray
With NA/NaN filled.
"""
value, method = validate_fillna_kwargs(value, method)

Expand Down Expand Up @@ -539,13 +540,14 @@ def shift(self, periods: int = 1, fill_value: object = None) -> ABCExtensionArra

fill_value : object, optional
The scalar value to use for newly introduced missing values.
The default is ``self.dtype.na_value``
The default is ``self.dtype.na_value``.

.. versionadded:: 0.24.0

Returns
-------
shifted : ExtensionArray
ExtensionArray
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this needs to be unindented to render properly

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

agreed, thanks

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@HughKelley can you fix this please, so we can merge. Thanks!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@datapythonista should I make the change with an additional commit or is there another way to do this?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Additional commit.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you fix the indantation here @HughKelley please?

Shifted.

Notes
-----
Expand Down Expand Up @@ -869,11 +871,12 @@ def view(self, dtype=None) -> Union[ABCExtensionArray, np.ndarray]:
Parameters
----------
dtype : str, np.dtype, or ExtensionDtype, optional
Default None
Default None.

Returns
-------
ExtensionArray
The array calling .view.
"""
# NB:
# - This must return a *new* object referencing the same data, not self.
Expand Down