DOC: Add examples and notes to empty documentation #12442
Conversation
masongallo
changed the title
| @@ -842,7 +842,25 @@ def __contains__(self, key): | |||
|
|
|||
| @property | |||
| def empty(self): | |||
| """True if NDFrame is entirely empty [no items]""" | |||
| """True if NDFrame is entirely empty [no items], i.e. all of the axes | |||
| Examples | ||
| -------- | ||
|
|
||
| >>> # containing only NaNs does not make the df empty |
There was a problem hiding this comment.
Can you make this a normal sentence (not a comment in the code block), and then leave a blank line between that and the code block on the following lines ?
|
Thanks! Further comment about the examples, I would start with an example of an actual empty frame (eg a DataFrame with only index), and only then show the example with the NaNs |
|
Thanks to both of you. Your suggestions make sense to me. I'll make those tweaks and I thought of one additional in line with yours:
|
|
That sounds good! |
|
Looks like travis hit a 404 from continuum's repo? I'm not seeing a 404 on my end.
|
|
Their servers were having issues last night. I've restarted the build. |
| """True if NDFrame is entirely empty [no items], i.e. any of the axes | ||
| are of length 0. | ||
|
|
||
| Notes |
There was a problem hiding this comment.
this should be below examples.
There was a problem hiding this comment.
To clarify, do you mean move the entire notes section below examples?
There was a problem hiding this comment.
I think it is OK to leave it here (Jeff, in the html rendered version, the notes will also be before the examples, irregardless of how the order is here)
|
thanks! |
git diff upstream/master | flake8 --diffAdded notes and examples to provide clarity around the issue discussed in #12393. This is my first contribution to pandas, so let me know if I need to fix anything.