From java-dev-return-12812-apmail-lucene-java-dev-archive=lucene.apache.org@lucene.apache.org Mon Feb 13 21:01:44 2006 Return-Path: Delivered-To: apmail-lucene-java-dev-archive@www.apache.org Received: (qmail 31691 invoked from network); 13 Feb 2006 21:01:44 -0000 Received: from hermes.apache.org (HELO mail.apache.org) (209.237.227.199) by minotaur.apache.org with SMTP; 13 Feb 2006 21:01:44 -0000 Received: (qmail 97914 invoked by uid 500); 13 Feb 2006 21:01:42 -0000 Delivered-To: apmail-lucene-java-dev-archive@lucene.apache.org Received: (qmail 97627 invoked by uid 500); 13 Feb 2006 21:01:41 -0000 Mailing-List: contact java-dev-help@lucene.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: java-dev@lucene.apache.org Delivered-To: mailing list java-dev@lucene.apache.org Received: (qmail 97616 invoked by uid 99); 13 Feb 2006 21:01:41 -0000 Received: from asf.osuosl.org (HELO asf.osuosl.org) (140.211.166.49) by apache.org (qpsmtpd/0.29) with ESMTP; Mon, 13 Feb 2006 13:01:41 -0800 X-ASF-Spam-Status: No, hits=0.0 required=10.0 tests= X-Spam-Check-By: apache.org Received-SPF: neutral (asf.osuosl.org: local policy) Received: from [169.229.70.167] (HELO rescomp.berkeley.edu) (169.229.70.167) by apache.org (qpsmtpd/0.29) with ESMTP; Mon, 13 Feb 2006 13:01:40 -0800 Received: by rescomp.berkeley.edu (Postfix, from userid 1007) id 554725B774; Mon, 13 Feb 2006 13:01:15 -0800 (PST) Received: from localhost (localhost [127.0.0.1]) by rescomp.berkeley.edu (Postfix) with ESMTP id 4B8547F403 for ; Mon, 13 Feb 2006 13:01:15 -0800 (PST) Date: Mon, 13 Feb 2006 13:01:15 -0800 (PST) From: Chris Hostetter To: java-dev@lucene.apache.org Subject: Re: 1.9 RC1 In-Reply-To: <43F0EC4B.5010709@apache.org> Message-ID: References: <43F0E8D1.8070805@apache.org> <43F0EC4B.5010709@apache.org> MIME-Version: 1.0 Content-Type: TEXT/PLAIN; charset=US-ASCII X-Virus-Checked: Checked by ClamAV on apache.org X-Spam-Rating: minotaur.apache.org 1.6.2 0/1000/N : This is a great time to improve the javadoc. I see lots of blank boxes : which could use a bit of descriptive text, for example: That reminds me about a documentation/release issue that's been rolling arround in the back of my mind that seems like it's only going to get worse as future releases are made... I think moving forward the query parser and fileformat docs should be moved into docfile directories within the java source, so they are reved/tagged with the individual releases. That way when people have questions about the file format of their index built with 1.9 they don't have to worry about changes that the version on the website documents the fileformat in 2.4 which is different. Likwise for questions about what syntax is valid in the version of QueryParser they are using. The only problem is that since 1.4.3 and previous versions didn't include these docs, the URL is the only resource they have. so i would suggest.. 1) Migrate the current versions of fileformats.html and queryparsersyntax.html into src/java/**/docfiles somwhere. 2) Revert the version of fileformats.html and queryparsersyntax.html on the website to their state when 1.4.3 was released. 3) Add a disclaimer at the top of those files indicating that they are for 1.4.3 and earlier, and are online for legacy purposes only. Developers using newer versions of lucene should consult the documentation included in the release they are using. -Hoss --------------------------------------------------------------------- To unsubscribe, e-mail: java-dev-unsubscribe@lucene.apache.org For additional commands, e-mail: java-dev-help@lucene.apache.org