|SUCCESS| dts: fix Sphinx parsing of a docstring

dpdklab at iol.unh.edu dpdklab at iol.unh.edu
Wed Apr 1 02:32:32 CEST 2026


Test-Label: ai-code-review
Test-Status: SUCCESS
https://dpdk.org/patch/162800

_AI Code Review_

=== Patch Review: series.patch (via Claude) ===
Review date: 2026-04-01

git sha: [from patchwork header - commit ID not present in patch]
Author: Thomas Monjalon <thomas at monjalon.net>
Subject: [PATCH] dts: fix Sphinx parsing of a docstring

This patch works around a Sphinx 9.1.0 parsing issue by splitting a
docstring into multiple lines to prevent the word "ports" from being
incorrectly parsed as a reference.

> diff --git a/dts/api/testpmd/config.py b/dts/api/testpmd/config.py
> index e71a3e1ef0..1e59bccd08 100644
> --- a/dts/api/testpmd/config.py
> +++ b/dts/api/testpmd/config.py

[ ... ]

> @@ -30,7 +30,8 @@
>  class PortTopology(StrEnum):
>      """Enum representing the port topology."""
>  
> -    #: In paired mode, the forwarding is between pairs of ports, e.g.: (0,1), (2,3), (4,5).
> +    #: In paired mode, the forwarding is between pairs of ports, e.g.:
> +    #: (0,1), (2,3), (4,5).

The comment continuation on line 2 appears to have incorrect alignment.
According to the DPDK coding style guide, multi-line comments should
maintain consistent indentation. Does the second comment line need
additional spaces to align with the text after the "#:" marker on the
first line? The guide specifies that continuation lines in block comments
should align with the text of the first line, not the comment marker.

>      paired = auto()
>  
>      #: In chained mode, the forwarding is to the next available port in the port mask, e.g.:


More information about the test-report mailing list