DOC: styling clean-up of docstrings (part 1, frame.py) #5560
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| @@ -2010,7 +2016,7 @@ def xs(self, key, axis=0, level=None, copy=True, drop_level=True): | |||
| which levels are used. Levels can be referred by label or position. | |||
| copy : boolean, default True | |||
| Whether to make a copy of the data | |||
| drop_level, default True | |||
| drop_level : boolean, default True | |||
There was a problem hiding this comment.
What do you prefer?
There was a problem hiding this comment.
A quick count: ca 6 times bool is used and around 50 times boolan in all docstrings in frame.py.
|
👍 |
| @@ -2146,13 +2152,11 @@ def lookup(self, row_labels, col_labels): | |||
|
|
|||
| Notes | |||
| ----- | |||
| Akin to | |||
| Akin to:: | |||
There was a problem hiding this comment.
yes, so it's regarded as code block.
|
@jorisvandenbossche is this ready to be merged? (I'm going to look through one more time, but just wanted to make sure you aren't planning to do anything else) |
|
@jtratner Yes, ready to merge! |
jtratner
added a commit
that referenced
this pull request
Nov 23, 2013
…leanup DOC: styling clean-up of docstrings (part 1, frame.py)
|
Looks good - thanks! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Some stylistic clean-up of the docstrings in frame.py.
Things changed are mainly:
:inparam : typemethodkeyword explanation in http://pandas.pydata.org/pandas-docs/dev/generated/pandas.DataFrame.corr.html