Logging docs - fix 'extras' typo

The logging argument is `extra` without the extra `s`.

See https://docs.python.org/3.8/library/logging.html#logging.Logger.debug
This commit is contained in:
Phil Ewels 2020-07-16 10:04:31 +02:00 committed by GitHub
parent 6b1daad6e4
commit 7dc3bb29b2
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -16,8 +16,8 @@ Here's an example of how to set up a rich logger::
log = logging.getLogger("rich")
log.info("Hello, World!")
Rich logs won't process console markup by default, but you can enable markup per log statement with the ``extras`` argument as follows::
Rich logs won't process console markup by default, but you can enable markup per log statement with the ``extra`` argument as follows::
log.error("[bold red blink]Server is shutting down![/]", extras={"markup": True})
log.error("[bold red blink]Server is shutting down![/]", extra={"markup": True})
There are a number of options you can use to configure logging output, see the :class:`~rich.logging.RichHandler` reference for details.
There are a number of options you can use to configure logging output, see the :class:`~rich.logging.RichHandler` reference for details.