Allow option to display absolute values for pie chart #19338 #25757
Conversation
chart #19338 Added a paramter wedgelabels to the pie() so the user can choose if they values are absolute or percentages. Renamed autopct with wedgelabelsfmt as the user requested.
There was a problem hiding this comment.
Thank you for opening your first PR into Matplotlib!
If you have not heard from us in a while, please feel free to ping @matplotlib/developers or anyone who has commented on the PR. Most of our reviewers are volunteers and sometimes things fall through the cracks.
You can also join us on gitter for real-time discussion.
For details on testing, writing docs, and our review process, please see the developer guide
We strive to be a welcoming and open project. Please follow our Code of Conduct.
There was a problem hiding this comment.
Thanks for this!
It is not clear to me how this works in practice. Right now, both autofmt and wedgelabelsfmt does the same thing? If so, why should we have both? If not, how can we deprecate autofmt later?
If it is only a matter of a "bad" name, then I think it is better to just have one name and use the decorator @_api.rename_parameter("3.8", "autofmt", "wedgelabelsfmt").
However, I would wait for additional input before going all in on these changes. (New arguments after * is a requirement though.)
Edit: after reading the issue, I think it should be quite OK to add the decorator as well.
| wedgeprops=None, textprops=None, center=(0, 0), | ||
| autopct=None, wedgelabels=None, wedgelabelsfmt=None, pctdistance=0.6, | ||
| shadow=False, labeldistance=1.1, startangle=0, radius=1, | ||
| counterclock=True, wedgeprops=None, textprops=None, center=(0, 0), | ||
| frame=False, rotatelabels=False, *, normalize=True, hatch=None): |
There was a problem hiding this comment.
The new arguments must be added after the * in case someone is using positional arguments.
|
I get the need and support supporting it, but I'm very iffy on coupled keywords - (wedgelabels, wedgelabelfmt) and would prefer an 'absolutefmt' keyword w/ the instruction that you cannot use both. Either way, I think wedgelabels is confusing cause labels is also confusing and we're really labeling the categories and amounts (maybe intertior labels?) And, as mentioned in the checklist, once settled this will need an example (I suggest adding it to the pie demo). |
|
Hi @codebreakymefix are you still interested in working in this? It looks like maybe you were waiting for reviewers to reach a consensus. I think I agree with @story645 on this that the proposed wedgelabels could be confusing. As the pie example shows, the current labels can be put on the wedge and the automatic percentage labels outside. Perhaps autolabels and autolabelfmt rather than wedge… might work? Or I also like @story645’s suggestion of an “absolute” format keyword that can’t be passed together with autopct. |
|
Discussion on parameter name also needs to consider the pctdistance parameter. |
PR Summary
Adds a parameter 'wedgelabels' to pie() for the user to display absolute or percent values in the wedges. Renamed 'autopct' to "wedgelabelsfmt" as the user requested.
closes #19338
PR Checklist
Linked Issue
Documentation and Tests
pytestpasses)Release Notes
.. versionadded::directive in the docstring and documented indoc/users/next_whats_new/.. versionchanged::directive in the docstring and documented indoc/api/next_api_changes/next_whats_new/README.rstornext_api_changes/README.rst