On Thu, Nov 07, 2002 at 02:00:47PM +0100, Andre Poenitz wrote: > No. The code _is_ the documentation. If it is unreadable, it is broken. > I know that we do not live in an ideal world, though, and LyX code _is_ > broken by this standard. But instead commenting the broken code, the code > should be fixed.
This is the ideal. However, as I said to Ben on IRC, as we transition to good code, it is VITAL that the stupid quirks and weirdo code (lyxcursor::ix() anybody ?) is documented so that people know what they are or are not breaking. We've seen too many "fixes" cause 5 more bugs due to this. regards john -- "When a man has nothing to say, the worst thing he can do is to say it memorably." - Calvin Trillin