Raise when both singular and plural scatter attributes are specified #19120
Milestone
Comments
|
Well - there should be some consistency at least. I think @brunobeltran is looking at overhauling this? |
new motto for matplotlib? :) |
|
Consistent, community-developed, flexible with lots of features. You may choose two. |
|
Hello I would like to starting contributing, I came across this issue and I would like to know if this would be a possible fix on the scatter function if linewidths is not None and kwargs.get('linewidth') is not None:
raise TypeError('linewidths and linewidth cannot be used simultaneously.')
if edgecolors is not None and kwargs.get('edgecolor') is not None:
raise TypeError('edgecolors and edgecolor cannot be used simultaneously.') |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
Problem
plt.scatteraccepts both singular and plural forms of thelinewidth(s)andedgecolor(s)attributes. The plural forms are documented in the function signature, but the singular forms actually take precedence if both are specified.This adds some complexity for downstream libraries and confusion for their users (cf. mwaskom/seaborn#2384).
Proposed Solution
Small change: Matplotlib could raise when both the singular and plural forms are specified.
Larger change: I will confess that I don't know why the plural forms of the kwargs exist. If there's not a strong reason for the duplication, perhaps they could be deprecated, or at least "formally discouraged"?
Additional context and prior art
Scatter does a lot of argument checking on the
c/colorparameters (too much at times, 😉), so there's some local precedence for a lot of handholding. On the other hand, matplotlib generally doesn't raise when both long- and short-forms of kwargs are givene.g.edgecolorandec`).The text was updated successfully, but these errors were encountered: