Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
dukebody opened this issue Mar 14, 2018 · 3 comments
Open

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

dukebody opened this issue Mar 14, 2018 · 3 comments
Labels

Comments

@dukebody
Copy link
Contributor

dukebody commented Mar 14, 2018

After the Pandas Sprint we have had many changes, see in a week or so if they are consistent. See #20155 (comment)

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
Copy link
Member

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
Copy link
Contributor Author

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
Copy link
Member

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

@TomAugspurger TomAugspurger modified the milestones: 0.23.0, Next Major Release Mar 29, 2018
@mroeschke mroeschke added the Visualization plotting label Jun 19, 2021
@mroeschke mroeschke removed this from the Contributions Welcome milestone Oct 13, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

4 participants