lucene-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Robert Muir (JIRA)" <>
Subject [jira] Commented: (SOLR-2379) Improve documentation of Analyzers and Tokenizers
Date Fri, 25 Feb 2011 14:41:38 GMT


Robert Muir commented on SOLR-2379:

I agree, if you find factories in trunk/branch_3x that do not @link the filter/tokenizer they
create, and don't describe how to use the factory (e.g. set parameters), I think we should
fix those.

I did a quick check for the former, and I think all factories link to the filter/tokenizer
they create.

In general I think its best if any parameters/options are described in the filters themselves
too, so that lucene users see this documentation, and so we can very verbosely describe what
these parameters do all in one place (to reduce confusion). 

Then any factories can simply link to the original documentation for the parameter values,
too. Here's an example:

> Improve documentation of Analyzers and Tokenizers
> -------------------------------------------------
>                 Key: SOLR-2379
>                 URL:
>             Project: Solr
>          Issue Type: Improvement
>          Components: documentation
>            Reporter: Jan H√łydahl
>            Priority: Minor
>              Labels: wiki
> See thread
> The Wiki page as well as are not up to date with current state.

This message is automatically generated by JIRA.
For more information on JIRA, see:


To unsubscribe, e-mail:
For additional commands, e-mail:

View raw message