Check kwargs description for all df and series plot submethods

pandas-dev / pandas

Flexible and powerful data analysis / manipulation library for Python, providing labeled data structures similar to R data.frame objects, statistical functions, and much more

https://pandas.pydata.org

BSD 3-Clause "New" or "Revised" License

43.32k stars 17.81k forks source link

Check kwargs description for all df and series plot submethods #20348

Open dukebody opened 6 years ago

dukebody commented 6 years ago

After the Pandas Sprint we have had many changes, see in a week or so if they are consistent. See https://github.com/pandas-dev/pandas/pull/20155#discussion_r174304114

The description of this parameter for all df/series.plot.* methods should be

Additional keywords are documented in :meth:`pandas.Series.plot`

(respectively with pandas.DataFrame.plot)

Assign to myself.

jorisvandenbossche commented 6 years ago

Yes, good idea. Also some others things varied a bit between PRs (the see also's, the return value (whether ndarray was explained), the summary line), those probably can use a clean-up as well when all plotting PRs are in.

dukebody commented 6 years ago

Cool. I have the list of df.plot method my local chapter (BCN) worked on so I can check this.

Apart from the kwargs description, can you comment on the rest of sections do you think that need consolidation? I'm not sure about what are the divergences in the "see also" and summary line that we would need to unify.

jorisvandenbossche commented 6 years ago

I would check some general things like:

Are the summary lines a bit consistent in format (like "draw" vs "genererate" vs "make" as verb)
In the See also, use somewhat consistent explanations. Eg DataFrame.plots is explained as " Make plots of a DataFrame." or "Make plots of DataFrame using matplotlib." (I don't think the matplotlib is needed), and in some cases not linked.
The returns section: sometimes the ndarray is explained, and sometimes not