Skip to content

Commit

Permalink
Merge pull request matplotlib#24926 from meeseeksmachine/auto-backpor…
Browse files Browse the repository at this point in the history
…t-of-pr-24925-on-v3.7.x

Backport PR matplotlib#24925 on branch v3.7.x (DOC: Improve documentation for set_loglevel)
  • Loading branch information
oscargus committed Jan 10, 2023
2 parents cef02fd + 6750316 commit 7ba4978
Showing 1 changed file with 13 additions and 2 deletions.
15 changes: 13 additions & 2 deletions lib/matplotlib/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -247,12 +247,22 @@ def _ensure_handler():

def set_loglevel(level):
"""
Set Matplotlib's root logger and root logger handler level, creating
the handler if it does not exist yet.
Configure Matplotlib's logging levels.
Matplotlib uses the standard library `logging` framework under the root
logger 'matplotlib'. This is a helper function to:
- set Matplotlib's root logger level
- set the root logger handler's level, creating the handler
if it does not exist yet
Typically, one should call ``set_loglevel("info")`` or
``set_loglevel("debug")`` to get additional debugging information.
Users or applications that are installing their own logging handlers
may want to directly manipulate ``logging.getLogger('matplotlib')`` rather
than use this function.
Parameters
----------
level : {"notset", "debug", "info", "warning", "error", "critical"}
Expand All @@ -263,6 +273,7 @@ def set_loglevel(level):
The first time this function is called, an additional handler is attached
to Matplotlib's root handler; this handler is reused every time and this
function simply manipulates the logger and handler's level.
"""
_log.setLevel(level.upper())
_ensure_handler().setLevel(level.upper())
Expand Down

0 comments on commit 7ba4978

Please sign in to comment.