Skip to content

Commit fc8fff8

Browse files
committed
docs(docstrings): Fix RST parameter formatting in log.py
- Fix malformed NumPy-style parameter documentation in template() - Fix double space in debug_log_template() parameter line - Standardize parameter descriptions to be concise
1 parent 7aca695 commit fc8fff8

File tree

1 file changed

+5
-7
lines changed

1 file changed

+5
-7
lines changed

src/tmuxp/log.py

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -76,14 +76,13 @@ def template(
7676
7777
Parameters
7878
----------
79-
:py:class:`logging.LogRecord` :
80-
object. this is passed in from inside the
81-
:py:meth:`logging.Formatter.format` record.
79+
record : :py:class:`logging.LogRecord`
80+
Object passed from :py:meth:`logging.Formatter.format`.
8281
8382
Returns
8483
-------
8584
str
86-
template for logger message
85+
Template for logger message.
8786
"""
8887
reset = Style.RESET_ALL
8988
levelname = set_style(
@@ -147,9 +146,8 @@ def debug_log_template(
147146
148147
Parameters
149148
----------
150-
record : :py:class:`logging.LogRecord`
151-
This is passed in from inside the :py:meth:`logging.Formatter.format`
152-
record.
149+
record : :py:class:`logging.LogRecord`
150+
Object passed from :py:meth:`logging.Formatter.format`.
153151
154152
Returns
155153
-------

0 commit comments

Comments
 (0)