diff --git a/doc/extdev/logging.rst b/doc/extdev/logging.rst index d0a139321..0d96c4eb9 100644 --- a/doc/extdev/logging.rst +++ b/doc/extdev/logging.rst @@ -9,9 +9,9 @@ Logging API .. autoclass:: SphinxLoggerAdapter(logging.LoggerAdapter) - .. method:: SphinxLoggerAdapter.error(level, msg, *args, **kwargs) - .. method:: SphinxLoggerAdapter.critical(level, msg, *args, **kwargs) - .. method:: SphinxLoggerAdapter.warning(level, msg, *args, **kwargs) + .. method:: SphinxLoggerAdapter.error(msg, *args, **kwargs) + .. method:: SphinxLoggerAdapter.critical(msg, *args, **kwargs) + .. method:: SphinxLoggerAdapter.warning(msg, *args, **kwargs) Logs a message on this logger with the specified level. Basically, the arguments are as with python's logging module. @@ -33,13 +33,14 @@ Logging API logger.warning('Warning happened!', location=some_node) **color** - The color of logs. By default, warning level logs are - colored as ``"darkred"``. The others are not colored. + The color of logs. By default, error level logs are colored as + ``"darkred"``, critical level ones is not colored, and warning level + ones are colored as ``"red"``. .. method:: SphinxLoggerAdapter.log(level, msg, *args, **kwargs) - .. method:: SphinxLoggerAdapter.info(level, msg, *args, **kwargs) - .. method:: SphinxLoggerAdapter.verbose(level, msg, *args, **kwargs) - .. method:: SphinxLoggerAdapter.debug(level, msg, *args, **kwargs) + .. method:: SphinxLoggerAdapter.info(msg, *args, **kwargs) + .. method:: SphinxLoggerAdapter.verbose(msg, *args, **kwargs) + .. method:: SphinxLoggerAdapter.debug(msg, *args, **kwargs) Logs a message to this logger with the specified level. Basically, the arguments are as with python's logging module. @@ -55,9 +56,8 @@ Logging API :meth:`SphinxLoggerAdapter.warning`. **color** - The color of logs. By default, debug level logs are - colored as ``"darkgray"``, and debug2 level ones are ``"lightgray"``. - The others are not colored. + The color of logs. By default, info and verbose level logs are not colored, + and deug level ones are colored as ``"darkgray"``. .. autofunction:: pending_logging()