You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@lucene.apache.org by "Mike Sokolov (JIRA)" <ji...@apache.org> on 2018/08/20 18:57:00 UTC
[jira] [Comment Edited] (LUCENE-765) Index package level javadocs
needs content
[ https://issues.apache.org/jira/browse/LUCENE-765?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16585289#comment-16585289 ]
Mike Sokolov edited comment on LUCENE-765 at 8/20/18 6:56 PM:
--------------------------------------------------------------
I took a stab at some general intro-level docs about the index, the writer, reader and different kinds of fields. The patch adds these new sections, links to them in the table of contents, and re-indents the entire file, but the existing documentation is otherwise unchanged.
was (Author: sokolov):
I took a stab at some general intro-level docs about the index generally, the writer, reader and different kinds of fields. The patch adds these new sections, links to them in the table of contents, and re-indents the entire file, but the existing documentation is otherwise unchanged.
> 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: dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: dev-help@lucene.apache.org