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

[Nathan Pratta Teodosio <nathan.teodosio@canonical.com>]

Package: python-apt-doc
Severity: normal
X-Debbugs-Cc: nathan.teodosio@canonical.com

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