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

Jump to bottom
Merged
merged 9 commits into from
Oct 14, 2019
Merged

DOC: fix formatting in the ExtensionArray docstrings #28686

merged 9 commits into from
Oct 14, 2019

Conversation

HughKelley
Copy link
Contributor

@pep8speaks
Copy link

pep8speaks commented Sep 30, 2019 •
edited
Loading

Hello @HughKelley! Thanks for updating this PR. We checked the lines you've touched for PEP 8 issues, and found:

There are currently no PEP 8 issues detected in this Pull Request. Cheers! 🍻

Comment last updated at 2019-10-14 21:05:31 UTC

@HughKelley
Copy link
Contributor Author

@datapythonista, seen above, there was an existing style error in the file modified for this pull request. Should I just go ahead and fix the line that is too long?

datapythonista
datapythonista reviewed Sep 30, 2019
View reviewed changes
Copy link
Member

@datapythonista datapythonista left a comment

Choose a reason for hiding this comment

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

Thanks for working on this, just couple of comments.

@jschendel jschendel added the Docs label Oct 1, 2019
@jschendel jschendel added this to the 1.0 milestone Oct 1, 2019
@jorisvandenbossche jorisvandenbossche changed the title Extension array docs DOC: fix formatting in the ExtensionArray docstrings Oct 1, 2019
WillAyd
WillAyd requested changes Oct 2, 2019
View reviewed changes
pandas/core/arrays/base.py Outdated

.. 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?

@HughKelley HughKelley force-pushed the ExtensionArray_docs branch from 7e834a4 to 149ba48 Compare October 8, 2019 12:56
@HughKelley HughKelley requested a review from WillAyd October 8, 2019 13:21
TomAugspurger
TomAugspurger reviewed Oct 14, 2019
View reviewed changes
pandas/core/arrays/base.py Outdated

Returns
-------
ExtensionArray
A view of the :class:`ExtensionArray` calling :meth:`view`.
Copy link
Contributor

Choose a reason for hiding this comment

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

I don’t think the :meth: resolves to anything.

Copy link
Contributor Author

@HughKelley HughKelley Oct 14, 2019 •
edited
Loading

Choose a reason for hiding this comment

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

thanks, It looked to me as though that functionality was not fully built out so I just tried to describe it as literally as possible in order to pass the checks. Would A view of the :class:ExtensionArray`` be sufficient?

Copy link
Member

Choose a reason for hiding this comment

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

yes, I think removing the calling... is good enough, thanks @HughKelley

datapythonista
datapythonista approved these changes Oct 14, 2019
View reviewed changes
Copy link
Member

@datapythonista datapythonista left a comment

Choose a reason for hiding this comment

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

lgtm, thanks @HughKelley

@HughKelley
Copy link
Contributor Author

HughKelley commented Oct 14, 2019 •
edited
Loading

@datapythonista

lgtm, thanks @HughKelley

First contribution to a project. Thanks for the help and direction!

@datapythonista
Copy link
Member

First contribution to a project. Thanks for the help and direction!

You're welcome. Hopefully not the last one. :)

WillAyd
WillAyd approved these changes Oct 14, 2019
View reviewed changes
Copy link
Member

@WillAyd WillAyd left a comment

Choose a reason for hiding this comment

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

lgtm as well ping when CI is green

@HughKelley
Copy link
Contributor Author

@WillAyd thanks!

@WillAyd WillAyd merged commit 5b0bf23 into pandas-dev:master Oct 14, 2019
@WillAyd
Copy link
Member

WillAyd commented Oct 14, 2019

Thanks @HughKelley

@HughKelley HughKelley deleted the ExtensionArray_docs branch October 14, 2019 21:50
proost pushed a commit to proost/pandas that referenced this pull request Dec 19, 2019
@HughKelley @proost
DOC: fix formatting in the ExtensionArray docstrings (pandas-dev#28686)
d43c281
proost pushed a commit to proost/pandas that referenced this pull request Dec 19, 2019
@HughKelley @proost
DOC: fix formatting in the ExtensionArray docstrings (pandas-dev#28686)
88ec63c
bongolegend pushed a commit to bongolegend/pandas that referenced this pull request Jan 1, 2020
@HughKelley
DOC: fix formatting in the ExtensionArray docstrings (pandas-dev#28686)
2fa0565
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@TomAugspurger TomAugspurger TomAugspurger left review comments

@WillAyd WillAyd WillAyd approved these changes

@datapythonista datapythonista datapythonista approved these changes

Assignees
No one assigned
Labels
Docs
Projects
None yet
Milestone
1.0.0
Development

Successfully merging this pull request may close these issues.

DOC: Fix formatting errors in pandas.api.extensions.ExtensionArray
6 participants
@HughKelley @pep8speaks @datapythonista @WillAyd @TomAugspurger @jschendel