diff mbox series

[1/2] ref-manual/classes: ptest-python-pytest: improve the current documentation

Message ID 20250403-release-note-5-2-updates-fixes-v1-1-13d16361f17c@bootlin.com
State Accepted
Headers show
Series Improvements and fixes for the 5.2 release | expand

Commit Message

Antonin Godard April 3, 2025, 2:08 p.m. UTC 
Improve the current ptest-python-pytest documentation and
PTEST_PYTEST_DIR variable definition. Namely remove the default value
that may evolve over time.

Suggested-by: Quentin Schulz <quentin.schulz@cherry.de>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
---
 documentation/ref-manual/classes.rst   | 7 +++----
 documentation/ref-manual/variables.rst | 2 +-
 2 files changed, 4 insertions(+), 5 deletions(-)

Comments

Quentin Schulz April 3, 2025, 2:21 p.m. UTC | #1 
Hi Antonin,

On 4/3/25 4:08 PM, Antonin Godard wrote:
> Improve the current ptest-python-pytest documentation and
> PTEST_PYTEST_DIR variable definition. Namely remove the default value
> that may evolve over time.
> 
> Suggested-by: Quentin Schulz <quentin.schulz@cherry.de>

Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>

Thanks!
Quentin
diff mbox series

Patch

diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst
index 8b930fe3d..59efcbe19 100644
--- a/documentation/ref-manual/classes.rst
+++ b/documentation/ref-manual/classes.rst
@@ -2712,13 +2712,12 @@  section in the Yocto Project Development Tasks Manual.
 ``ptest-python-pytest``
 =======================
 
-The :ref:`ref-classes-ptest-python-pytest` class can be used in Python-based
+The :ref:`ref-classes-ptest-python-pytest` class can be inherited in Python-based
 recipes to automatically configure the :ref:`ref-classes-ptest` class for Python
 packages leveraging the `pytest <https://docs.pytest.org>`__ unit test framework.
 
-Within the recipe, the :term:`PTEST_PYTEST_DIR` variable can be overridden to
-specify the path to the directory containing the tests (default value:
-``tests``). Test contained in this directory are installed in :term:`D` by the
+Within the recipe, the :term:`PTEST_PYTEST_DIR` variable specifies the path to
+the directory containing the tests that will be installed in :term:`D` by the
 :ref:`ref-tasks-install_ptest_base` task, as well as a specific ``run-ptest``
 script for this task.
 
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 0f65620a5..266470bd5 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -7393,7 +7393,7 @@  system and gives an overview of their function and contents.
    :term:`PTEST_PYTEST_DIR`
       Within the :ref:`ref-classes-ptest-python-pytest` class, the
       :term:`PTEST_PYTEST_DIR` variable represents the path within the source
-      tree of a Python package holding the unit tests to be tested with the
+      tree of a Python package holding the unit tests to be run with the
       `pytest <https://docs.pytest.org>`__ framework. The default value for this
       variable is ``tests``.