Return-Path: X-Original-To: apmail-lucene-dev-archive@www.apache.org Delivered-To: apmail-lucene-dev-archive@www.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id 8BFE99232 for ; Wed, 8 Feb 2012 15:51:32 +0000 (UTC) Received: (qmail 14408 invoked by uid 500); 8 Feb 2012 15:51:31 -0000 Delivered-To: apmail-lucene-dev-archive@lucene.apache.org Received: (qmail 14349 invoked by uid 500); 8 Feb 2012 15:51:30 -0000 Mailing-List: contact dev-help@lucene.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@lucene.apache.org Delivered-To: mailing list dev@lucene.apache.org Received: (qmail 14327 invoked by uid 99); 8 Feb 2012 15:51:30 -0000 Received: from nike.apache.org (HELO nike.apache.org) (192.87.106.230) by apache.org (qpsmtpd/0.29) with ESMTP; Wed, 08 Feb 2012 15:51:30 +0000 X-ASF-Spam-Status: No, hits=-0.0 required=5.0 tests=RCVD_IN_DNSWL_LOW,SPF_NEUTRAL X-Spam-Check-By: apache.org Received-SPF: neutral (nike.apache.org: local policy) Received: from [209.85.212.176] (HELO mail-wi0-f176.google.com) (209.85.212.176) by apache.org (qpsmtpd/0.29) with ESMTP; Wed, 08 Feb 2012 15:51:24 +0000 Received: by wibhq12 with SMTP id hq12so613181wib.35 for ; Wed, 08 Feb 2012 07:51:03 -0800 (PST) Received: by 10.216.138.130 with SMTP id a2mr7096004wej.42.1328716263257; Wed, 08 Feb 2012 07:51:03 -0800 (PST) MIME-Version: 1.0 Received: by 10.216.176.211 with HTTP; Wed, 8 Feb 2012 07:50:43 -0800 (PST) In-Reply-To: References: From: Michael McCandless Date: Wed, 8 Feb 2012 10:50:43 -0500 Message-ID: Subject: Re: DR.getCommitUserData() vs DR.getIndexCommit().getUserData() To: dev@lucene.apache.org Content-Type: text/plain; charset=ISO-8859-1 Content-Transfer-Encoding: quoted-printable X-Gm-Message-State: ALoCoQmUwuTScA+bVfAAXDsHO6H584xPc7/ZEw7Naly9wQpCIaLtbgO4wcw5qxv/1o0DTlkC446p X-Virus-Checked: Checked by ClamAV on apache.org I'll open an issue for this... definitely needs some cleanup. Thank for raising this Ryan! Mike McCandless http://blog.mikemccandless.com On Tue, Feb 7, 2012 at 7:33 PM, Robert Muir wrote: > Related: investigating these methods, I think the javadocs/possibly > other method names could be improved. > > In my opinion the problem is the use of 'current' which is: > 1. inconsistent/trappy: its getVersion()/getCurrentVersion(Directory), > but getCommitUserData()/getCommitUserData(Directory) <-- the > 'overloading' here is not good. > 2. ambiguous: its intended to be interpreted as 'most recent' for > these static methods that return Directory, but this word 'current' > could also be read as 'currently in use'. > > So for example, when the javadocs says: 'from current index segments > file', I think for these static Directory-methods we could try to > consistently rephrase as 'from most recent commit to the provided > directory' or something more clear. > > On Tue, Feb 7, 2012 at 7:16 PM, Ryan McKinley wrote: >> On Tue, Feb 7, 2012 at 3:11 PM, Michael McCandless >> wrote: >>> Hmmm no difference. =A0I don't like ambiguity... we should remove one! >>> (I think remove DR's method?). >>> >> >> +1 =A0If they do the same thing, we should try to get rid of one. >> >> --------------------------------------------------------------------- >> To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org >> For additional commands, e-mail: dev-help@lucene.apache.org >> > > > > -- > lucidimagination.com > > --------------------------------------------------------------------- > To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org > For additional commands, e-mail: dev-help@lucene.apache.org > --------------------------------------------------------------------- To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org For additional commands, e-mail: dev-help@lucene.apache.org