lucene-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From David Spencer <dave-lucene-...@tropo.com>
Subject Re: Study Group (WAS Re: Normalized Scoring)
Date Mon, 07 Feb 2005 23:07:50 GMT
Doug Cutting wrote:

> Paul Elschot wrote:
> 
>> I learned a lot by adding some javadocs to such classes. I suppose Doug
>> added the Expert markings, but I don't know their precise purpose.
> 
> 
> The "Expert" declaration is meant to indicate that most users should not 
> need to understand the feature.  Lucene's API seeks to be both simple 
> and flexible, but this is not always possible.  When flexibility is 
> added that is not part of the simple API, it is deemed "expert".  For 
> example, we don't expect most users to need to write new Query 
> implementations.  So Query methods that are only used internally in 
> query processing are marked "Expert", since they only need to be 
> understood by those implementing a Query.

I think this is an excellent way of giving guidance to users - you want 
to indicate what they'd normally use, and what they should initially 
stay away from.

> 
> Doug
> 
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: lucene-dev-unsubscribe@jakarta.apache.org
> For additional commands, e-mail: lucene-dev-help@jakarta.apache.org
> 


---------------------------------------------------------------------
To unsubscribe, e-mail: lucene-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: lucene-dev-help@jakarta.apache.org


Mime
View raw message