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

[Luca Vizzarro <Luca.Vizzarro@arm.com>]

Hi all,

I've noticed that this approach of writing Steps and Verify doesn't 
really render nicely in Sphinx. The sections are fine, those are 
rendered ok, but every line in the section is not rendered on a new 
line. But all inline. An rendered example of this example:

   Steps:
     Launch testpmd. Check port info.

Should we switch this to (un)ordered lists instead?

Discussion opener aside, just one comment on the changes.

Best,
Luca


On 22/07/2025 18:19, Dean Marx wrote:
> --- 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.
> +      "

needs triple "