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

DOC: Extend docstring pandas core index to_frame method #20036

Merged
merged 8 commits into from
Mar 10, 2018
Merged

DOC: Extend docstring pandas core index to_frame method #20036

Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
5387d95
Shift text to short summary
stijnvanhoey Mar 7, 2018
b99e4a2
Move default to parameter description
stijnvanhoey Mar 7, 2018
90eb4af
Split return info to separate line
stijnvanhoey Mar 7, 2018
2e26d8a
Provide example solutions
stijnvanhoey Mar 7, 2018
f3e1019
Remove trailing whitespace
stijnvanhoey Mar 7, 2018
535eba9
Move default to same line of type
stijnvanhoey Mar 7, 2018
e6cbbbe
update based on changes in guide
jorisvandenbossche Mar 7, 2018
b32b416
Provide name to index initiation
stijnvanhoey Mar 7, 2018
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
5 changes: 3 additions & 2 deletions pandas/core/indexes/base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1110,13 +1110,14 @@ def to_series(self, index=None, name=None):
return Series(self._to_embed(), index=index, name=name)

def to_frame(self, index=True):
"""Create a DataFrame with a column containing the Index.
"""
Create a DataFrame with a column containing the Index.

.. versionadded:: 0.21.0

Parameters
----------
index : boolean (default True)
index : boolean, default True
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@jorisvandenbossche on the docstring guide rst file, the example dosctring provides: color : str (default 'blue'). So should it be (default True) or , default True?

Copy link
Member

Choose a reason for hiding this comment

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

Whoops, I was using the virtual in my head :-) That's something we need to fix, we decided on , default True I think

Copy link
Contributor Author

Choose a reason for hiding this comment

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

See, python-sprints/python-sprints.github.io#62

Set the index of the returned DataFrame as the original Index.

Returns
Expand Down