lucene-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Shai Erera (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (LUCENE-4894) Facet User Guide for lucene 4.2 has deleted classes/methods and needs more explanations.
Date Tue, 02 Apr 2013 07:21:15 GMT

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

Shai Erera commented on LUCENE-4894:
------------------------------------

The userguide is seriously outdated after all the recent refactoring. I was wondering if we
should keep it at all, or rather include a high-level documentation under o.a.l.facet.package.html
which covers the basic points, and then focus on maintaining good javadocs at the classes
/ packages level. It gets harder to maintain these documents ...

Nevertheless, if you want to take a crack at improving / fixing it, I will help you get it
in.
                
> Facet User Guide for lucene 4.2 has deleted classes/methods and needs more explanations.
> ----------------------------------------------------------------------------------------
>
>                 Key: LUCENE-4894
>                 URL: https://issues.apache.org/jira/browse/LUCENE-4894
>             Project: Lucene - Core
>          Issue Type: Bug
>          Components: general/website, modules/facet
>    Affects Versions: 4.2
>            Reporter: crocket
>            Priority: Minor
>
> * Concurrent Indexing and Search
> There is no clear explanation regarding those points below.
> 1. TaxonomyReader should be reopened after IndexReader.
> 2. TaxonomyWriter should be committed before IndexWriter. TaxonomyWriter should be closed
before IndexWriter.
> The rationale is that it's ok to see categories to which no document belongs but not
ok the other way around.
> Beginners may not be able to see this until after they think through it for a long time,
which most of them including me wouldn't do.
> However, facet user guide doesn't explain the rationale clearly.
> * DocumentBuilder & FacetSearchParams.addFacetRequest
> They no longer exist in lucene 4.2, but they are used in code examples.
> * FacetResultNode.getLabel(TaxonomyReader)
> It doesn't eixst in 4.2, but it is mentioned in "Multiple Facet Requests"
> * ETC
> I don't know if there are other points to be made.

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira

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


Mime
View raw message