FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

Fix #21101 Add validator to errorbar method by Kislovskiy · Pull Request #21266 · matplotlib/matplotlib · GitHub

  1. matplotlib
  2. matplotlib

Repository navigation

Fix #21101 Add validator to errorbar method - #21266

Merged
timhoffm merged 10 commits into
matplotlib:masterfrom
Kislovskiy:fix-21101
Oct 5, 2021
ConversationCommits (10)ChecksFiles changed
Merged

Fix #21101 Add validator to errorbar method#21266
timhoffm merged 10 commits into
matplotlib:masterfrom
Kislovskiy:fix-21101

Conversation

Kislovskiy commented Oct 2, 2021

Copy link
Copy Markdown
Contributor

PR Summary

The PR adds a validator for xerr and yerr arguments in errorbar method to fix #21101.

It brings implementation compliant with the documentation:

Note that all error arrays should have positive values.

source: https://github.com/matplotlib/matplotlib/blob/master/lib/matplotlib/axes/_axes.py#L3183

PR Checklist

  • 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.
  • [N/A] 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).

github-actions Bot reviewed Oct 2, 2021
View reviewed changes

github-actions Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

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.

jklymak reviewed Oct 4, 2021
View reviewed changes
Comment thread lib/matplotlib/axes/_axes.py Outdated
jklymak added this to the v3.6.0 milestone Oct 4, 2021
jklymak added the API: argument checking Validation of acceptable argument values label Oct 4, 2021
anntzer reviewed Oct 4, 2021
View reviewed changes
Comment thread lib/matplotlib/axes/_axes.py Outdated
try:
if np.any(array < 0):
return True
except TypeError: # Don't fail on 'datetime.*' types

anntzer Oct 4, 2021

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

It's unclear to me why we wouldn't want to fail with datetime types. After all you can't add datetimes so using them as x/yerr should fail, afaict (you can add a datetime to a timedelta, but timedeltas can be meaningfully compared to zero).

Kislovskiy Oct 4, 2021

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Thanks @anntzer! Yeah, I added this line to not fail on datetime.timedelta

matplotlib/lib/matplotlib/tests/test_units.py

Line 174 in 6d56592

ax.errorbar(x, y, timedelta(days=0.5))

I've assumed that it's always positive. Let me see if there is a way to check that they are "meaningful compared to zero".

anntzer Oct 4, 2021

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Ah, I was thinking about np.timedelta, not datetime.timedelta, sorry for the careless reading (np.timedelta(...) > 0 works). Well, I guess my point remains: it would be nice to have the check also for datetime.timedelta inputs, but I don't know how easy that is.

Kislovskiy Oct 4, 2021

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

@anntzer I've added a check for timedelta types. However, I'm a bit uncomfortable with checking only timedelta type. datetime.datetime handles only positive values -> should not be an issue. What about datetime.date?

you can add a datetime to a timedelta

Do you mean, that there is a way to convert anything to timedelta and check it? If yes, could you elaborate a bit more?

anntzer Oct 4, 2021

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

I agree the special-casing is a bit annoying, I don't have any good solution to offer right now though.

timhoffm reviewed Oct 4, 2021
View reviewed changes
Comment thread lib/matplotlib/axes/_axes.py Outdated
Comment thread lib/matplotlib/axes/_axes.py Outdated
Comment thread lib/matplotlib/axes/_axes.py Outdated
timhoffm merged commit e37902e into matplotlib:master Oct 5, 2021

timhoffm commented Oct 5, 2021

Copy link
Copy Markdown
Member

Thanks @Kislovskiy, and congratulations on your first contribution to Matplotlib. We hope to see you again.

Kislovskiy commented Oct 5, 2021

Copy link
Copy Markdown
Contributor Author

Thanks @timhoffm @jklymak @anntzer for the review! Very appreciate your input

Kislovskiy deleted the fix-21101 branch October 5, 2021 15:40
tacaswell pushed a commit to tacaswell/matplotlib that referenced this pull request Oct 12, 2021
Merge pull request matplotlib#21266 from Kislovskiy/fix-21101
8a35be5 
Fix matplotlib#21101 Add validator to errorbar method
timhoffm mentioned this pull request Oct 15, 2021
Merged
tacaswell pushed a commit that referenced this pull request Oct 20, 2021
Merge pull request #21266 from Kislovskiy/fix-21101
8798ab0 
Fix #21101 Add validator to errorbar method
timhoffm mentioned this pull request Jun 26, 2023
Closed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

anntzer anntzer left review comments
github-actions[bot] github-actions[bot] left review comments
jklymak jklymak approved these changes
timhoffm timhoffm approved these changes

Assignees

No one assigned

Labels

API: argument checking Validation of acceptable argument values

Projects

None yet

Milestone

v3.6.0

Development

Successfully merging this pull request may close these issues.

[Bug]: Errorbars separated from markers with negative errors

4 participants

Back | FazBrowse Home | New Git URL