lucene-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Lewis John McGibbney (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (LUCENE-765) Index package level javadocs needs content
Date Thu, 15 Mar 2018 07:47:00 GMT

    [ https://issues.apache.org/jira/browse/LUCENE-765?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16400046#comment-16400046
] 

Lewis John McGibbney commented on LUCENE-765:
---------------------------------------------

Hi Folks, I would be interested in taking this issue on as what I believe would be my first
Lucene contribution.
The _index_ package is significant though. [~gsingers] can you scope out any immedite areas
where you think the documentation would benefit?
Thanks

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


Mime
View raw message