From: Blair Z. <bl...@or...> - 2003-04-15 17:22:53
|
Brian Hurt wrote: > > On Tue, 15 Apr 2003, Nicolas Cannasse wrote: > > > Excellent, but since this is an "advanced feature", I suggest that you move > > the resizers to the end of the mli, so they will appear at the end of the > > documentation. > > No problemo. The only reason they're first is that they're that way in > the .ml file. > > > > > > - The .mli file now has doc comments! Yay! The .ml file still needs to > > > be commented. > > > > Does it really needs ? > > I don't especially like comments in source files, they are only needed when > > you're doing something very difficult to understand... > > I have been surprised at what is "intuitively obvious" one day, and > "completely inexplicable" sometime later. While I don't think there is > any 'inexplicable' code in this source file, I'm a firm beleiver in better > safe than sorry. Agreed. I can't believe there's a suggestion to remove documentation :) I suggest we keep it in there. Best, Blair -- Blair Zajac <bl...@or...> Plots of your system's performance - http://www.orcaware.com/orca/ |