Skip to content
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

Standardize docstrings to use pd.DataFrame/pd.Series #18770

Closed
tdpetrou opened this issue Dec 13, 2017 · 1 comment · Fixed by #18788
Closed

Standardize docstrings to use pd.DataFrame/pd.Series #18770

tdpetrou opened this issue Dec 13, 2017 · 1 comment · Fixed by #18788
Labels
Docs good first issue
Milestone
0.23.0

Comments

@tdpetrou
Copy link
Contributor

Problem description

All docstrings should be consistent with DataFrame/Series creation and use pd. to access them as this is what most users use. I was looking through pandas/core/frame.py and there are 9 instances of a docstring having df = DataFrame(...) vs 30 that have df = pd.DataFrame(...).

It would be nice to standardize this and possibly other similar inconsistencies - but this is the largest one that stood out.
@jreback jreback added this to the Next Major Release milestone Dec 15, 2017
accraze added a commit to accraze/pandas that referenced this issue Dec 15, 2017
@accraze
DOC: standardizing docstrings to use pd.DataFrame
c23482c 
closes pandas-dev#18770
@accraze accraze mentioned this issue Dec 15, 2017
Merged
4 tasks
@jorisvandenbossche jorisvandenbossche modified the milestones: Next Major Release, 0.22.0 Dec 16, 2017
@jorisvandenbossche
Copy link
Member

@tdpetrou This issue is closed by the PR, but I suppose the same will occur in different files.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Docs good first issue
Projects
None yet
Milestone
0.23.0
Development

Successfully merging a pull request may close this issue.

DOC: standardizing docstrings to use pd.DataFrame accraze/pandas
3 participants
@jreback @jorisvandenbossche @tdpetrou