Skip to content

Commit

Permalink
Fix docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ElliottKasoar committed Apr 2, 2024
1 parent d9ca4ff commit e29be93
Showing 1 changed file with 18 additions and 1 deletion.
19 changes: 18 additions & 1 deletion janus_core/log.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,27 @@
"""


class CustomFormatter(logging.Formatter):
class CustomFormatter(logging.Formatter): # numpydoc ignore=PR02
"""
Custom formatter to convert multiline messages into yaml list.
Parameters
----------
fmt : str
A format string in the given style for the logged output as a whole. Default is
'%(message)s'.
datefmt : str
A format string in the given style for the date/time portion of the logged
output. Default is taken from logging.Formatter.formatTime().
style : str
Determines how the format string will be merged with its data. Can be one of
'%', '{' or '$'. Default is '%'.
validate : bool
If True, incorrect or mismatched fmt and style will raise a ValueError. Default
is True.
defaults : dict[str, Any]
A dictionary with default values to use in custom fields.
Methods
-------
format(record)
Expand Down

0 comments on commit e29be93

Please sign in to comment.