Re: [jira] Commented: (LUCENE-664) [PATCH] small fixes to the new scoring.html doc

[Chris Hostetter <ho...@fucit.org>]

: 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 seperation of hte site in the tree certainly makes keeping them in
sync less easy then keeping the javadocs in sync -- but the fact that the
"site" at the moment of a release is bundled in with the release makes it
a pretty optimal place for things like this.

that said, it certainly seems like sections of the scoring.html might make
more sense in the javadocs, leaving the file to be more of a "skeleton" of
links out .. likewise this doc should be refrenced by more links *from*
javadocs of various classes.

if this was something i was building for work, i'd put all of this info
in a doc-files directory so it was completely bundled with both the source
code and any build of the javadocs -- but nobody i work with really agrees
with me that doc-files directories are cool either.




-Hoss


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