Boost logo

Boost-Build :

From: David Abrahams (dave_at_[hidden])
Date: 2002-11-12 13:20:01

Rene Rivera <grafik666_at_[hidden]> writes:

> On this I disagree... I think documentation output, to console,
> should be re-wrapped, just as it would be if it was HTML instead. I
> know people generally write sensible-looking comments, but that is
> subjective. They write sensible comments on their editor, which
> invariably is always set to different proportions to everyone
> else. So people who use variable width fonts will write longer lines
> than fixed width editing people causing strange and inconsistent
> output to whoever reads the documentation. And documentation should
> be the one thing that is the most consistent in a program, as it's
> usually the first interface to your program people see.

Sure. As long as your re-wrapper doesn't reinterpret my intentional
breaks and indentation, I think the trade-off is in favor of
re-wrapping (assuming you can tell something intelligent about how
wide to make the output). However, once it starts garbling what I've
written in the comment, the trade-off starts to go the other way.

David Abrahams
dave_at_[hidden] *
Boost support, enhancements, training, and commercial distribution

Boost-Build list run by bdawes at, david.abrahams at, gregod at, cpdaniel at, john at