[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

Bug#865847: Use reStructuredText for Lintian manual



Felix Lechner <felix.lechner@lease-up.com> writes:

> As you already wrote, RST and Markdown are not that different,
> certainly when compared to Docbook. RST, however, is a lot better
> suited for technical documentation, especially APIs. [1]

For what it's worth, we looked at Markdown for Debian Policy and went with
RST instead because Markdown just doesn't have enough features for large
documents.  Lintian's documentation may not be large enough for it to
matter, but Markdown, while more featureful than POD, isn't that much more
featureful and has some definite gaps.  (Even assuming that one uses a
variant of Markdown with table and definition list support, which can be a
bit hard to find.)

-- 
Russ Allbery (rra@debian.org)               <http://www.eyrie.org/~eagle/>


Reply to: