[PATCH v3 1/2] doc: add test case docstring example to dts rst

Luca Vizzarro Luca.Vizzarro at arm.com
Tue Aug 26 16:15:02 CEST 2025


Looks good, just one minor problem.

On 20/08/2025 15:39, Dean Marx wrote:
> diff --git a/doc/guides/tools/dts.rst b/doc/guides/tools/dts.rst
> index 3837b398cf..31eceb6c43 100644
> --- a/doc/guides/tools/dts.rst
> +++ b/doc/guides/tools/dts.rst
> @@ -414,6 +414,22 @@ Test Cases
>      A test suite may include any number of functional and/or performance test cases.
>      Each suite should focus on testing a single feature (one feature = one test suite).
>   
> +   Test case docstrings must include a Steps and Verify section. For example:
> +
> +   Example::
> +
> +      @func_test
> +      def test_basic_link(self):
> +      """Tests basic link status.
> +
> +      Steps:
> +         * Launch testpmd.
> +         * Check port info.
> +
> +      Verify:
> +         * Port info shows link status is up.
> +      """
the docstring should be indented further.> +
>   Setup and Teardown Hooks
>   
>      Setup and teardown methods can be defined at both the suite and test case levels.



More information about the dev mailing list