[
https://issues.apache.org/jira/browse/LUCENE-765?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16591281#comment-16591281
]
Adrien Grand commented on LUCENE-765:
-------------------------------------
Thanks Mike, it looks great. Here are some suggestions:
- I'm a bit reluctant to mention distributed filesystems as something that a
Directory can abstract as it is usually a better idea to handle distribution on
top of Lucene like Solr does with shards/replicas.
- In the IndexReader section, maybe link "open" to DirectoryReader#open and
"refreshed" to DirectoryReader#openIfChanged?
- Let's mention that doc ids are transient and only valid for a given
point-in-time view of the index?
- Doc values mention "rapid random-access lookup", shouldn't it be "rapid
sequential lookup"?
- Let's avoid saying that doc values may be used for retrieval as it suggests
that this might be an alternative for stored fields?
> Index package level javadocs needs content
> ------------------------------------------
>
> Key: LUCENE-765
> URL: https://issues.apache.org/jira/browse/LUCENE-765
> Project: Lucene - Core
> Issue Type: Wish
> Components: general/javadocs
> Reporter: Grant Ingersoll
> Priority: Minor
> Labels: newdev
> Attachments: LUCENE-765.patch, LUCENE-765.patch
>
>
> The org.apache.lucene.index package level javadocs are sorely lacking. They
> should be updated to give a summary of the important classes, how indexing
> works, etc. Maybe give an overview of how the different writers coordinate.
> Links to file formats, information on the posting algorithm, etc. would be
> helpful.
> See the search package javadocs as a sample of the kind of info that could go
> here.
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
