|
From: Ethan M. <merritt@u.washington.edu> - 2006-04-05 16:22:43
|
On Wednesday 05 April 2006 09:01 am, you wrote:
> Ethan A Merritt wrote:
>
> > The docs state that the supported syntax is '{' followed immediately
> > by '/'. The code does support this. It also forgives intervening
> > whitespace, which is undocumented.
>
> There's a difference between being undocumented and contradicting the
> documentation, even more so if the relevant part of the documentation
> SHOUTS. Documentation stating wrong facts is a bug in its own right.
I don't see how it can ever be a bug for the documentation to say
"the supported syntax requires that blah, blah, blah".
If the docs tell you not to do something, but you do it anyway,
the fact that it happens to work is not a bug. If it works today
but not tomorrow, that also is not a bug.
I do agree that it is odd for the documentation to SHOUT while
stating the supported syntax.
--
Ethan A Merritt
Biomolecular Structure Center
University of Washington, Seattle WA
|