From ec76cf55f027375b80dc9581a736526ada04dc40 Mon Sep 17 00:00:00 2001 From: Patrick Lannigan Date: Tue, 31 Oct 2023 14:03:55 -0400 Subject: [PATCH] Apply documentation suggestions Co-authored-by: Ran Benita Co-authored-by: Bruno Oliveira --- doc/en/how-to/output.rst | 5 +++-- src/_pytest/assertion/__init__.py | 2 +- src/_pytest/assertion/truncate.py | 2 +- 3 files changed, 5 insertions(+), 4 deletions(-) diff --git a/doc/en/how-to/output.rst b/doc/en/how-to/output.rst index 10784b8bb..3e401b3c6 100644 --- a/doc/en/how-to/output.rst +++ b/doc/en/how-to/output.rst @@ -270,16 +270,17 @@ situations, for example you are shown even fixtures that start with ``_`` if you Using higher verbosity levels (``-vvv``, ``-vvvv``, ...) is supported, but has no effect in pytest itself at the moment, however some plugins might make use of higher verbosity. -Fine gain verbosity +Fine-grained verbosity ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ In addition to specifying the application wide verbosity level, it is possible to control specific aspects independently. This is done by setting a verbosity level in the configuration file for the specific aspect of the output. -``verbosity_assertions``: Controls how verbose the assertion output should be when pytest is executed. A value of ``2`` +:confval:`verbosity_assertions`: Controls how verbose the assertion output should be when pytest is executed. A value of ``2`` would have the same output as the previous example, but each test inside the file is shown by a single character in the output. +(Note: currently this is the only option available, but more might be added in the future). .. _`pytest.detailed_failed_tests_usage`: Producing a detailed summary report diff --git a/src/_pytest/assertion/__init__.py b/src/_pytest/assertion/__init__.py index 5cf0cfc34..8ffb32d9d 100644 --- a/src/_pytest/assertion/__init__.py +++ b/src/_pytest/assertion/__init__.py @@ -48,7 +48,7 @@ def pytest_addoption(parser: Parser) -> None: "assertions", help=( "Specify a verbosity level for assertions, overriding the main level. " - "Higher levels will provide more a more detailed explanation when an assertion fails." + "Higher levels will provide more detailed explanation when an assertion fails." ), ) diff --git a/src/_pytest/assertion/truncate.py b/src/_pytest/assertion/truncate.py index 8f4252d40..e6d870196 100644 --- a/src/_pytest/assertion/truncate.py +++ b/src/_pytest/assertion/truncate.py @@ -1,7 +1,7 @@ """Utilities for truncating assertion output. Current default behaviour is to truncate assertion explanations at -terminal lines, unless running with a verbosity level of at least 2 or running on CI. +terminal lines, unless running with an assertions verbosity level of at least 2 or running on CI. """ from typing import List from typing import Optional