lucene-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Grant Ingersoll <grant.ingers...@gmail.com>
Subject Re: [jira] Commented: (LUCENE-664) [PATCH] small fixes to the new scoring.html doc
Date Thu, 24 Aug 2006 20:57:24 GMT
See below

On Aug 24, 2006, at 4:17 PM, Michael McCandless (JIRA) wrote:

>     [ http://issues.apache.org/jira/browse/LUCENE-664? 
> page=comments#action_12430293 ]
>
> Michael McCandless commented on LUCENE-664:
> -------------------------------------------
>
> OK I did some more small fixes to the sections "Query Classes" and  
> "Changing Similarity".  Just added some missing links, fixed a  
> broken link, tightened up wording, etc.  I'll attach a patch.
>
> Also a couple random questions:
>
>   * Should this go into the Wiki or into the Web site?  Is there a  
> general criteria / guideline that we've converged on for Wiki vs  
> Web site?

This seems like a first level document to me.  I thought about  
putting it up on the Wiki initially so it would be easier to get  
edits done and then promote it, but in the end decided not to.  I  
think things on the Wiki get buried and ignored to some extent.   
People are always asking about scoring and the query classes and how  
to override these things, so I think that justifies it as top-level  
document in my mind.

>
>   * Is there a reason why we are linking to the "ViewVC" page in  
> the Big Picture section?  Can't we just link to the javadoc?

There are no javadocs for the ones in question, I don't think.  I  
believe the ones in question are related to BooleanWeight* and  
BooleanScorer*  The ViewVC page was a compromise of not providing any  
links.


>
>   * Should we change the title / purpose to be an overview of the  
> Query classes and also details of scoring?  I think the Query  
> Classes section is a great intro to the different Query classes.

or even split them out into a separate document????


>
>> [PATCH] small fixes to the new scoring.html doc
>> -----------------------------------------------
>>
>>                 Key: LUCENE-664
>>                 URL: http://issues.apache.org/jira/browse/LUCENE-664
>>             Project: Lucene - Java
>>          Issue Type: Improvement
>>          Components: Website
>>    Affects Versions: 2.0.1
>>            Reporter: Michael McCandless
>>         Attachments: lucene.uxf, scoring-small-fixes.patch,  
>> scoring-small-fixes2.patch
>>
>>
>> This is an awesome initiative.  We need more docs that cleanly  
>> explain the inner workings of Lucene in general... thanks Grant &  
>> Steve & others!
>> I have a few small initial proposed fixes, largely just adding  
>> some more description around the components of the formula.  But  
>> also a couple typos, another link out to Wikipedia, a missing  
>> closing ), etc.  I've only made it through the "Understanding the  
>> Scoring Formula" section so far.
>
> -- 
> This message is automatically generated by JIRA.
> -
> If you think it was sent incorrectly contact one of the  
> administrators: http://issues.apache.org/jira/secure/ 
> Administrators.jspa
> -
> For more information on JIRA, see: http://www.atlassian.com/ 
> software/jira
>
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: java-dev-unsubscribe@lucene.apache.org
> For additional commands, e-mail: java-dev-help@lucene.apache.org
>

------------------------------------------------------
Grant Ingersoll
http://www.grantingersoll.com/



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


Mime
View raw message