Skip to content

Fine-tune logging notes in contributing.rst. #12094

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 2 commits into from
Sep 11, 2018
Merged

Fine-tune logging notes in contributing.rst. #12094

merged 2 commits into from
Sep 11, 2018

Conversation

anntzer
Copy link
Contributor

@anntzer anntzer commented Sep 11, 2018

PR Summary

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

@anntzer
Fine-tune logging notes in contributing.rst.
efdd8d7 
- Note that warnings.warn displays warnings only once, and suggest to
  use it for things that should be modified in the source (it's not for
  no reason that it displays the corresponding line in the source...).
- Suggest not logging at INFO level for normal code paths.
timhoffm
timhoffm approved these changes Sep 11, 2018
View reviewed changes
doc/devel/contributing.rst Outdated
`logging.debug` is the least likely to be displayed, and hence can
be the most verbose.
`logging.debug` is the least likely to be displayed, and hence can be the most
verbose. "Expected" code paths (e.g., reporting normal intermediat steps of
Copy link
Member

Choose a reason for hiding this comment

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

typo: intermediate

@jklymak jklymak merged commit 22906c2 into matplotlib:master Sep 11, 2018
@anntzer anntzer deleted the logging branch September 11, 2018 20:23
@QuLogic QuLogic added this to the v3.1 milestone Sep 12, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@timhoffm timhoffm timhoffm approved these changes

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

Successfully merging this pull request may close these issues.
4 participants
@anntzer @timhoffm @QuLogic @jklymak