8000 Make margins error as claimed in doc-string by oscargus · Pull Request #23535 · matplotlib/matplotlib · GitHub
[go: up one dir, main page]
Skip to content

Make margins error as claimed in doc-string #23535

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Aug 3, 2022
Merged

Make margins error as claimed in doc-string #23535

merged 1 commit into from
Aug 3, 2022

Conversation

oscargus
Copy link
Member
@oscargus oscargus commented Aug 1, 2022

PR Summary

Built on top of #23453 so better merge that first.

The documentation says:

Passing both positional and keyword
arguments is invalid and will raise a TypeError.

But it is currently possible to pass e.g. margins(0.2, x=0) which will set both margins to 0.2.

As this corrects the stated behaviour of the doc-string I assume that no change note is required?

PR Checklist

Tests and Styling

  • Has pytest style unit tests (and pytest passes).
  • Is Flake 8 compliant (install flake8-docstrings and run flake8 --docstring-convention=all).

Documentation

  • [N/A] New features are documented, with examples if plot related.
  • [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).
  • [N/A] Documentation is sphinx and numpydoc compliant (the docs should build without error).

@oscargus oscargus added this to the v3.6.0 milestone Aug 1, 2022
@tacaswell
Copy link
Member

Did you only mean to include the second commit in this PR?

@tacaswell
Copy link
Member

oh, I see now 🐑 Sorry, can not read...

QuLogic
QuLogic reviewed Aug 3, 2022
View reviewed changes
@oscargus oscargus force-pushed the marginserror branch 5 times, most recently from 7cc4382 to f07b234 Compare August 3, 2022 10:37
@QuLogic QuLogic merged commit 60b4104 into matplotlib:main Aug 3, 2022
@oscargus oscargus deleted the marginserror branch August 3, 2022 22:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tacaswell tacaswell tacaswell approved these changes

@QuLogic QuLogic QuLogic approved these changes

Assignees
No one assigned
Labels
topic: axes topic: mplot3d
Projects
None yet
419A Milestone
v3.6.0
Development

Successfully merging this pull request may close these issues.
3 participants
@oscargus @tacaswell @QuLogic
0