#1068697 python-apt-doc: Property 'comment' of Deb822SourceEntry is not clearly described.

Package:
python-apt-doc
Source:
python-apt-doc
Submitter:
Nathan Pratta Teodosio
Date:
2024-04-09 08:21:06 UTC
Severity:
normal
#1068697#5
Date:
2024-04-09 08:19:49 UTC
From:
To:
Hi,

the documentation[1] describes the 'comment' property of a SourceEntry as
--->
property comment: str

    Legacy attribute describing the paragraph header.
<---

I think it is unclear what constitutes a paragraph header and that consumers
end up having to infer it via trial and error.

[1] https://apt-team.pages.debian.net/python-apt/library/aptsources.sourceslist.html#aptsources.sourceslist.Deb822SourceEntry.comment