[LTP] [PATCH 1/1] doc/conf.py: Replace all titles

[Andrea Cervesato]

Hi Petr,

On 2/18/25 13:15, Petr Vorel wrote:
> This fixes titles like "[Race Description]".
>
> Fixes: 1bf344a3db ("doc: add tests catalog page")
> Signed-off-by: Petr Vorel <pvorel@suse.cz>
> ---
>   doc/conf.py | 8 ++------
>   1 file changed, 2 insertions(+), 6 deletions(-)
>
> diff --git a/doc/conf.py b/doc/conf.py
> index 03fcff67e8..e1d02d63e8 100644
> --- a/doc/conf.py
> +++ b/doc/conf.py
> @@ -455,12 +455,8 @@ def generate_test_catalog(_):
>           if desc:
>               desc_text = []
>               for line in desc:
> -                if line.startswith("[Description]"):
> -                    desc_text.append("**Description**")
> -                elif line.startswith("[Algorithm]"):
> -                    desc_text.append("**Algorithm**")
> -                else:
> -                    desc_text.append(line)
> +                line = re.sub(r'^\[([A-Za-z][\w\W]+)\]', r'**\1**', line)

The idea is good, but the implementation can be optimized. We can 
"re.compile()" the regex __before__ reading all the lines, then we can 
use the compiled object to substitute the string. In this way we won't 
compile the regexp for each line and the string processing will be faster.

https://docs.python.org/3/library/re.html#re.compile
https://docs.python.org/3/library/re.html#re.Pattern.sub

> +                desc_text.append(line)
>   
>               text.extend([
>                   '\n'.join(desc_text),
Andrea