Re: [LTP] [RFC] Remove [Description] subtitle from docparse

[Petr Vorel <pvorel@suse.cz>]

Hi Andrea,

> Hi Petr,

> I'm currently working on parsing metadata in order to produce a tests list
> in the LTP documentation.
FYI I planned to work on it (announced in ML [1]), but since you started I stop
working on it.

> I just replace "[Description]" with "**Description**". Same for
> "[Algorithm]".

> I would keep the bold version tho, with the double star **.

We talk about a different things. You about the conversion of the subtitles to
the final documentation (previously was done in docparse/testinfo.pl, now you
will do it in python).

But I'm suggesting to entirely remove subtitle "Description". It looks to me
useless and some people don't add it thus docs looks inconsistent.

Kind regards,
Petr

> Andrea

> On 1/31/25 10:15, Petr Vorel wrote:
> > Hi,

> > Can we remove [Description] part from docparse documentation in tests?
> > This is transformed into "Description" subtitle in resulted html/pdf.

> > 1) It's not really needed (it's obvious that it's a description of the test)
> > 2) Sometimes it's missing (inconsistency).

> > I would keep other subtitles (e.g. [Algorithm]), just remove the first one.

> > Kind regards,
> > Petr

[1] https://lore.kernel.org/ltp/20241227073921.GB290415@pevik/

-- 
Mailing list info: https://lists.linux.it/listinfo/ltp