On Fri, Apr 24, 2020 at 06:28:54PM +0100, Peter Lister wrote: > On 21/04/2020 18:23, Christoph Hellwig wrote: >> It wasn't entirely uncommon, but that's not really the point. The >> Problem is all the weird ".." or "::" annotations that really kill >> the flow, or things like "|copy|" that have no reason to exist. > > You aren't supposed to read REST documentation files - as opposed to > kerneldoc comments in the C source - any more than you read HTML. And that is the whole problem. Optimizing for reading in a browser might be an okay tradeoff for end-user documentation. But it is absolutely the wrong thing for internal API documentation where you want to jump to them by opening them in the same text editor.
