Skip to content

Fix Docs: Don’t warn for unused ignores #15043

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 13, 2019
Merged

Fix Docs: Don’t warn for unused ignores #15043

merged 1 commit into from
Aug 13, 2019

Conversation

alexrudy
Copy link
Contributor

PR Summary

Warnings emitted for unused nitpick ignores were causing CI to fail a lot, and are hard to track down and fix. This should remove that pain.

See issue #15042

PR Checklist

  • Has Pytest style unit tests
  • Code is Flake 8 compliant
  • New features are documented, with examples if plot related
  • Documentation is sphinx and numpydoc compliant
  • Added an entry to doc/users/next_whats_new/ if major new feature (follow instructions in README.rst there)
  • Documented in doc/api/api_changes.rst if API changed in a backward-incompatible way

@tacaswell tacaswell added this to the v3.2.0 milestone Aug 12, 2019
@ImportanceOfBeingErnest
Copy link
Member

Maybe I do not understand this; but aren't unused ignores actually nice to have warnings about? Those are the ones that are easily fixed.

tacaswell
tacaswell approved these changes Aug 12, 2019
View reviewed changes
Copy link
Member

@tacaswell tacaswell left a comment

Choose a reason for hiding this comment

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

I am in favor of merging this to reduce the amount of thrashing we have while we sort out how to use this tool most effectively.

Particularly as @ImportanceOfBeingErnest reports that some of these may be coming from sphinx gallery.

@tacaswell tacaswell mentioned this pull request Aug 12, 2019
Closed
@ImportanceOfBeingErnest
Copy link
Member

Just to say, I'm not convinced anymore that sphinx_gallery has anything to do with those. What I was seeing is due to an error (maybe windows related? or maybe it cannot be used locally?).

ImportanceOfBeingErnest
ImportanceOfBeingErnest approved these changes Aug 13, 2019
View reviewed changes
Copy link
Member

@ImportanceOfBeingErnest ImportanceOfBeingErnest left a comment

Choose a reason for hiding this comment

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

I do by now think we need to ignore the unused ignores to come to a point where everything is stable again.

@ImportanceOfBeingErnest ImportanceOfBeingErnest merged commit 96c7c51 into matplotlib:master Aug 13, 2019
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

@ImportanceOfBeingErnest ImportanceOfBeingErnest ImportanceOfBeingErnest approved these changes

Assignees
No one assigned
Labels
Documentation
Projects
None yet
Milestone
v3.2.0
Development

Successfully merging this pull request may close these issues.
4 participants
@alexrudy @ImportanceOfBeingErnest @tacaswell @dstansby