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 <[email protected]> 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 <[email protected]> wrote: >> On Tue, Feb 7, 2012 at 3:11 PM, Michael McCandless >> <[email protected]> wrote: >>> Hmmm no difference. I don't like ambiguity... we should remove one! >>> (I think remove DR's method?). >>> >> >> +1 If they do the same thing, we should try to get rid of one. >> >> --------------------------------------------------------------------- >> To unsubscribe, e-mail: [email protected] >> For additional commands, e-mail: [email protected] >> > > > > -- > lucidimagination.com > > --------------------------------------------------------------------- > To unsubscribe, e-mail: [email protected] > For additional commands, e-mail: [email protected] > --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
