Docs for lurking groupby methods

[cpcloud]

see this SO question

related: http://stackoverflow.com/questions/21763660/api-ref-missing-dataframegroupby-objects

methods like nunique should be documented; i bet there are more like this that you can see in tab completion but that are valid method calls.

[hayd]

(I think probably worth going through "everything", still quite a lot not online.)

[jreback]

+1 for script that finds non-doced methods?

[cpcloud]

i thought @y-p wrote one

oh you mean non doc in documentation?

[jreback]

yep.....does that find nunique in groupby? (as having no docs)?

[cpcloud]

oh sorry his is for undoc'd arguments. not hard to write script to find things with no docstrings, there's ast.get_docstring(ast.parse(arbitrary_python_code)), but checking to see if there are (rst) docs on something like nunique for groupby seems really difficult

[hayd]

Is there a script which checks for docstrings? I was thinking the other day a few which have the @property docstring, would be good to find them all with a "deep" find...

Was talking more about online docs, e.g. just added get_dummies #4444 in recent pr.

[cpcloud]

i think to do the deep find you'd need to compile into byte code first

[cpcloud]

ast will only parse the raw source which means those run eval'd docstrings wno't show up

[jreback]

hmm....let's close in favor of #6944

[cpcloud]

cool

[jorisvandenbossche]

yep, I added a last bullet to mention this specifically.

BTW, @jreback, do you know if this would be easy possible? To add a docstring to the wrapped functions in the apply whitelist?

[jreback]

@jorisvandenbossche

I think you just need to do something like this: https://github.com/pydata/pandas/blob/master/pandas/core/groupby.py#L495
but for __doc__ (and just copy the doc from the function)

[jorisvandenbossche]

ah yes, thanks. We could maybe eg just add the __doc__ of the original functions but prepend it with one line explaining it acts on each group or something like that.

Will add this to the list in #6944