Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Fix documentation of edgecolors precedence for scatter() #18791

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

Merged
merged 2 commits into from
Oct 22, 2020
Merged

Fix documentation of edgecolors precedence for scatter() #18791

merged 2 commits into from
Oct 22, 2020

Conversation

BH4
Copy link
Contributor

@BH4 BH4 commented Oct 22, 2020

PR Summary

Precedence of edgecolor and edgecolors in scatter() documentation was incorrect. This changes the documentation to match the observed precedence.

Issue #18392

PR Checklist

  • [N/A] Has pytest style unit tests (and pytest passes).
  • Is Flake 8 compliant (run flake8 on changed files to check).
  • [N/A] New features are documented, with examples if plot related.
  • Documentation is sphinx and numpydoc compliant (the docs should build without error).
  • Conforms to Matplotlib style conventions (install flake8-docstrings and run flake8 --docstring-convention=all).
  • [N/A] New features have an entry in doc/users/next_whats_new/ (follow instructions in README.rst there).
  • [N/A] API changes documented in doc/api/next_api_changes/ (follow instructions in README.rst there).

@QuLogic
Copy link
Member

QuLogic commented Oct 22, 2020

I believe facecolor should have higher precedence over facecolors as well. Can you update that as well?

But also, since edgecolors is an explicit argument name in scatter, I think it can never appear in kwargs. So I wonder why this is even done...

@timhoffm
Copy link
Member

But also, since edgecolors is an explicit argument name in scatter, I think it can never appear in kwargs. So I wonder why this is even done...

You're right, it can't. But it's also not checked or documented to be in kwargs. The code is edgecolors = kwargs.pop('edgecolor', edgecolors). Note the singular / plural in pop().

@timhoffm
Copy link
Member

Anybody can merge after CI pass.

@QuLogic QuLogic merged commit ab36eaa into matplotlib:master Oct 22, 2020
@QuLogic
Copy link
Member

QuLogic commented Oct 22, 2020

You're right, it can't. But it's also not checked or documented to be in kwargs. The code is edgecolors = kwargs.pop('edgecolor', edgecolors). Note the singular / plural in pop().

Ah you're right. I knew I looked at this before, and didn't change it for some reason, but missed the plurality again.

@QuLogic QuLogic added this to the v3.4.0 milestone Oct 22, 2020
@BH4 BH4 deleted the scatter_edgecolor_precedence_documentation branch October 25, 2020 19:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants