You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@lucene.apache.org by "Adrien Grand (JIRA)" <ji...@apache.org> on 2018/08/30 20:07:00 UTC
[jira] [Resolved] (LUCENE-765) Index package level javadocs needs
content
[ https://issues.apache.org/jira/browse/LUCENE-765?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Adrien Grand resolved LUCENE-765.
---------------------------------
Resolution: Fixed
Fix Version/s: master (8.0)
7.5
I was still backporting a couple changes. Agreed!
> 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
> Fix For: 7.5, master (8.0)
>
> Attachments: LUCENE-765.patch, LUCENE-765.patch, LUCENE-765.patch, 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: dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: dev-help@lucene.apache.org