From mboxrd@z Thu Jan 1 00:00:00 1970 Received: (from majordomo@localhost) by pauillac.inria.fr (8.7.6/8.7.3) id IAA14738; Tue, 9 Oct 2001 08:26:50 +0200 (MET DST) X-Authentication-Warning: pauillac.inria.fr: majordomo set sender to owner-caml-list@pauillac.inria.fr using -f Received: from concorde.inria.fr (concorde.inria.fr [192.93.2.39]) by pauillac.inria.fr (8.7.6/8.7.3) with ESMTP id IAA14726 for ; Tue, 9 Oct 2001 08:26:49 +0200 (MET DST) Received: from pauillac.inria.fr (pauillac.inria.fr [128.93.11.35]) by concorde.inria.fr (8.11.1/8.10.0) with ESMTP id f996Qm515130; Tue, 9 Oct 2001 08:26:48 +0200 (MET DST) Received: (from fpottier@localhost) by pauillac.inria.fr (8.7.6/8.7.3) id IAA14732; Tue, 9 Oct 2001 08:26:48 +0200 (MET DST) Date: Tue, 9 Oct 2001 08:26:48 +0200 From: Francois Pottier To: Maxence Guesdon Cc: caml-list@inria.fr Subject: [Caml-list] Re: [Caml-announce] OCamldoc Message-ID: <20011009082648.A14690@pauillac.inria.fr> Reply-To: Francois.Pottier@inria.fr References: <3BC218CA.9060008@inria.fr> Mime-Version: 1.0 Content-Type: text/plain; charset=iso-8859-1 Content-Transfer-Encoding: 8bit X-Mailer: Mutt 1.0i In-Reply-To: <3BC218CA.9060008@inria.fr>; from maxence.guesdon@inria.fr on Mon, Oct 08, 2001 at 05:21:14PM -0400 Sender: owner-caml-list@pauillac.inria.fr Precedence: bulk Hi, > I'm pleased to announce a pre-release of OCamldoc, which i hope will > become the "javadoc for OCaml". Congratulations for this very nice piece of work. A question about comment placement: isn't it a bit inconsistent to expect comments for record fields to be placed *after* the record, while the opposite convention is used for object fields? I would consider it more consistent to always require the comment to precede the element. The purpose of the current convention concerning record fields and data constructors seems to be to encourage people to write comments that fit on the remainder on the line, which is bad practice anyway. -- François Pottier Francois.Pottier@inria.fr http://pauillac.inria.fr/~fpottier/ ------------------- Bug reports: http://caml.inria.fr/bin/caml-bugs FAQ: http://caml.inria.fr/FAQ/ To unsubscribe, mail caml-list-request@inria.fr Archives: http://caml.inria.fr