CLN/DOC: add axis parameter doc for filter method #7197
Merged
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
| @@ -1757,6 +1756,8 @@ def filter(self, items=None, like=None, regex=None, axis=None): | |||
| Keep info axis where "arg in col == True" | |||
| regex : string (regular expression) | |||
| Keep info axis with re.search(regex, col) == True | |||
| axis : int or None | |||
| The axis to filter on. By default this is the info axis | |||
There was a problem hiding this comment.
Good to add this!
Only, I personally think the expression info axis is not very clear what this means. That is never used in the docs (apart for a very few docstrings, like this)
There was a problem hiding this comment.
I agree however I didn't want to launch into the reasoning behind this. Maybe we can add a section at the top of the API docs about this?
There was a problem hiding this comment.
@jorisvandenbossche I can add something to the FAQ, if that would be helpful.
There was a problem hiding this comment.
you can also just say that this is the [] index, e.g. DataFrame=1,Series=0,Panel=0
There was a problem hiding this comment.
you can put this in 0.14.0
cpcloud
added a commit
that referenced
this pull request
May 22, 2014
CLN/DOC: add axis parameter doc for filter method
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.
removing some unused imports and added
axisparameter doc forfiltermethod