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

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: 
http://svn.apache.org/repos/asf/lucene/dev/trunk/solr/src/java/org/apache/solr/spelling/DirectSolrSpellChecker.java


> Improve documentation of Analyzers and Tokenizers
> -------------------------------------------------
>
>                 Key: SOLR-2379
>                 URL: https://issues.apache.org/jira/browse/SOLR-2379
>             Project: Solr
>          Issue Type: Improvement
>          Components: documentation
>            Reporter: Jan Høydahl
>            Priority: Minor
>              Labels: wiki
>
> See thread http://search-lucene.com/m/S7l5XMQ8iA1
> The Wiki page http://wiki.apache.org/solr/AnalyzersTokenizersTokenFilters as 
> well as http://wiki.apache.org/solr/LanguageAnalysis are not up to date with 
> current state.

-- 
This message is automatically generated by JIRA.
-
For more information on JIRA, see: http://www.atlassian.com/software/jira



---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to