Skip to content

DOC: Fix formatting errors in pandas.api.extensions.ExtensionArray #28685

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
Closed
HughKelley opened this issue Sep 30, 2019 · 0 comments · Fixed by #28686
Closed

DOC: Fix formatting errors in pandas.api.extensions.ExtensionArray #28685

HughKelley opened this issue Sep 30, 2019 · 0 comments · Fixed by #28686

Comments

@HughKelley
Copy link
Contributor

HughKelley commented Sep 30, 2019 •
edited
Loading 

python scripts/validate_docstrings.py pandas.api.extensions.ExtensionArray.view

python scripts/validate_docstrings.py pandas.api.extensions.ExtensionArray.fillna

python scripts/validate_docstrings.py pandas.api.extensions.ExtensionArray.shift

Problem description

pandas.api.extensions.ExtensionArray.view: Parameter "dtype" description should finish with "."
pandas.api.extensions.ExtensionArray.view: Return value has no description

pandas.api.extensions.ExtensionArray.fillna: Parameter "method" description should finish with "."
pandas.api.extensions.ExtensionArray.fillna: The first line of the returns section should contain only the type, unless multiple values are being returned
pandas.api.extensions.ExtensionArray.fillna: Return value has no description

pandas.api.extensions.ExtensionArray.shift: Parameter "fill_value" description should finish with "."
pandas.api.extensions.ExtensionArray.shift: The first line of the returns section should contain only the type, unless multiple values are being returned
pandas.api.extensions.ExtensionArray.shift: Return value has no description


This is a subset of #27977  and #28602
HughKelley added a commit to HughKelley/pandas that referenced this issue Sep 30, 2019
@HughKelley
fix doc string for ExtensionArray.fillna issue pandas-dev#28685
a0b1ae3
HughKelley added a commit to HughKelley/pandas that referenced this issue Sep 30, 2019
@HughKelley
fix doc string return value description for ExtensionArray.fillna issue
a0e5097 
pandas-dev#28685
HughKelley added a commit to HughKelley/pandas that referenced this issue Sep 30, 2019
@HughKelley
fix doc string formatting errors for ExtensionArray.view issue pandas…
8901b20 
…-dev#28685
HughKelley added a commit to HughKelley/pandas that referenced this issue Sep 30, 2019
@HughKelley
fix doc string formatting errors for ExtensionArray.shift issue panda…
32f9a21 
…s-dev#28685
@HughKelley HughKelley mentioned this issue Sep 30, 2019
Merged
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

DOC: fix formatting in the ExtensionArray docstrings HughKelley/pandas
1 participant
@HughKelley