lucene-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Grant Ingersoll (JIRA)" <j...@apache.org>
Subject [jira] Commented: (LUCENE-664) [PATCH] small fixes to the new scoring.html doc
Date Wed, 30 Aug 2006 18:22:25 GMT
    [ http://issues.apache.org/jira/browse/LUCENE-664?page=comments#action_12431645 ] 
            
Grant Ingersoll commented on LUCENE-664:
----------------------------------------

Yeah, I thought about putting it in Javadoc and I share your concern about invalidation, but
I think that is always the case with all documentation, including javadocs, and is just something
we have to live with and work on.  I also think it is bigger picture than javadocs and spans
multiple packages, so it doesn't really fit as nicely into the Javadoc model of package level
documentation.   My hope is that by making it a part of the main site and something people
can easily find it will be better maintained. 

> [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,
scoring-small-fixes3.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


Mime
View raw message