Skip to content

Commit f1a74fe

Browse files
TOML integer log levels must be quoted: Updating reference documentation (#14255) (#14264)
Fixes #14253 (cherry picked from commit 2755310) Co-authored-by: Samuel Newbold <sam@rwsh.org>
1 parent 32a95ce commit f1a74fe

2 files changed

Lines changed: 13 additions & 3 deletions

File tree

changelog/14255.doc.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
TOML integer log levels must be quoted: Updating reference documentation.

doc/en/reference/reference.rst

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1836,21 +1836,24 @@ passed multiple times. The expected format is ``name=value``. For example::
18361836

18371837

18381838
Sets the minimum log message level that should be captured for live logging. The integer value or
1839-
the names of the levels can be used.
1839+
the names of the levels can be used. Note in TOML the integer must be quoted, as there is no support
1840+
for config parameters of mixed type.
18401841

18411842
.. tab:: toml
18421843

18431844
.. code-block:: toml
18441845
18451846
[pytest]
18461847
log_cli_level = "INFO"
1848+
log_cli_level = "10"
18471849
18481850
.. tab:: ini
18491851

18501852
.. code-block:: ini
18511853
18521854
[pytest]
18531855
log_cli_level = INFO
1856+
log_cli_level = 10
18541857
18551858
For more information, see :ref:`live_logs`.
18561859

@@ -1951,21 +1954,24 @@ passed multiple times. The expected format is ``name=value``. For example::
19511954

19521955

19531956
Sets the minimum log message level that should be captured for the logging file. The integer value or
1954-
the names of the levels can be used.
1957+
the names of the levels can be used. Note in TOML the integer must be quoted, as there is no support
1958+
for config parameters of mixed type.
19551959

19561960
.. tab:: toml
19571961

19581962
.. code-block:: toml
19591963
19601964
[pytest]
19611965
log_file_level = "INFO"
1966+
log_cli_level = "10"
19621967
19631968
.. tab:: ini
19641969

19651970
.. code-block:: ini
19661971
19671972
[pytest]
19681973
log_file_level = INFO
1974+
log_cli_level = 10
19691975
19701976
For more information, see :ref:`logging`.
19711977

@@ -2020,21 +2026,24 @@ passed multiple times. The expected format is ``name=value``. For example::
20202026

20212027

20222028
Sets the minimum log message level that should be captured for logging capture. The integer value or
2023-
the names of the levels can be used.
2029+
the names of the levels can be used. Note in TOML the integer must be quoted, as there is no support
2030+
for config parameters of mixed type.
20242031

20252032
.. tab:: toml
20262033

20272034
.. code-block:: toml
20282035
20292036
[pytest]
20302037
log_level = "INFO"
2038+
log_cli_level = "10"
20312039
20322040
.. tab:: ini
20332041

20342042
.. code-block:: ini
20352043
20362044
[pytest]
20372045
log_level = INFO
2046+
log_cli_level = 10
20382047
20392048
For more information, see :ref:`logging`.
20402049

0 commit comments

Comments
 (0)