lucene-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Doug Cutting (JIRA)" <j...@apache.org>
Subject [jira] Commented: (LUCENE-664) [PATCH] small fixes to the new scoring.html doc
Date Thu, 31 Aug 2006 19:51:23 GMT
    [ http://issues.apache.org/jira/browse/LUCENE-664?page=comments#action_12431954 ] 
            
Doug Cutting commented on LUCENE-664:
-------------------------------------

Javadoc is easiest to keep in sync with changes to the code, since it is in the same files.
 The wiki is the hardest to keep in sync with the code, since it is not versioned with the
code.  We website is somewhere between: it is in subversion, but in separate files in a separate
tree.

The javadoc is thus the preferred location for documentation that is specific to the code.
 The website and wiki are better for stuff that's specific to the project: policys, procedures,
etc.  The wiki is great for user-generated stuff like benchmarks, porting tricks, use cases,
etc.

This stuff seems pretty closely tied to the code, so I'd put it in the javadoc.  It's nearly
all stuff that's in the search package, so much of this could go in search/package.html with
pointers to the javadoc for Query, Weight, Scorer, etc.

> [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