[jira] [Comment Edited] (LUCENE-8453) Add example settings to Korean analyzer components' javadocs

2018-08-10 Thread Tomoko Uchida (JIRA)


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

Tomoko Uchida edited comment on LUCENE-8453 at 8/11/18 2:20 AM:


Slightly off topic, feel free to ignore, but I think Solr example settings 
should be removed from TokenizerFactory/TokenFilterFactory/CharFilterFactory 
documentation. I suppose there may be historical reasons, so I followed the 
convention, but it is not reasonable to add Solr schema examples here. Not XML 
schema examples, but parameter descriptions are needed to each Factory 
documentation.


was (Author: tomoko uchida):
Slightly off topic, feel free to ignore, but I think Solr example settings 
should be removed from Tokenizer/TokenFilter/CharFilter documentation. I 
suppose there may be historical reasons, so I followed the convention, but it 
is not reasonable to add Solr schema examples here. Not XML schema examples, 
but parameter descriptions are needed to each Factory documentation.

> Add example settings to Korean analyzer components' javadocs
> 
>
> Key: LUCENE-8453
> URL: https://issues.apache.org/jira/browse/LUCENE-8453
> Project: Lucene - Core
>  Issue Type: Improvement
>  Components: general/javadocs
>Reporter: Tomoko Uchida
>Priority: Minor
>
> Korean analyzer (nori) javadoc needs example schema settings.
> I'll create a patch.



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)

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



[jira] [Comment Edited] (LUCENE-8453) Add example settings to Korean analyzer components' javadocs

2018-08-10 Thread Tomoko Uchida (JIRA)


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

Tomoko Uchida edited comment on LUCENE-8453 at 8/11/18 1:42 AM:


So here are my proposal for javadoc's example settings (my pull request)  :)

For KoreanTokenizerFactory:
{code:xml}

   
 
  
 
{code}
For KoreanPartOfSpeechStopFilterFactory:
{code:xml}


  
  

 
{code}
For KoreanReadingFormFilterFactory:
{code:xml}

   
 
 
   
 
{code}

Update:
Added brief descriptions for each parameter (please see the pull request,) 
though unfortunately, Kuromoji's documentation lacks those.


was (Author: tomoko uchida):
So here are my proposal for javadoc's example settings (my pull request)  :)

For KoreanTokenizerFactory:
{code:xml}

   
 
  
 
{code}
For KoreanPartOfSpeechStopFilterFactory:
{code:xml}


  
  

 
{code}
For KoreanReadingFormFilterFactory:
{code:xml}

   
 
 
   
 
{code}

> Add example settings to Korean analyzer components' javadocs
> 
>
> Key: LUCENE-8453
> URL: https://issues.apache.org/jira/browse/LUCENE-8453
> Project: Lucene - Core
>  Issue Type: Improvement
>  Components: general/javadocs
>Reporter: Tomoko Uchida
>Priority: Minor
>
> Korean analyzer (nori) javadoc needs example schema settings.
> I'll create a patch.



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)

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



[jira] [Comment Edited] (LUCENE-8453) Add example settings to Korean analyzer components' javadocs

2018-08-10 Thread Tomoko Uchida (JIRA)


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

Tomoko Uchida edited comment on LUCENE-8453 at 8/10/18 10:50 PM:
-

So here are my proposal for javadoc's example settings (my pull request)  :)

For KoreanTokenizerFactory:
{code:xml}

   
 
  
 
{code}
For KoreanPartOfSpeechStopFilterFactory:
{code:xml}


  
  

 
{code}
For KoreanReadingFormFilterFactory:
{code:xml}

   
 
 
   
 
{code}


was (Author: tomoko uchida):
So my proposal for javadoc's example settings (my pull request) is here :)

For KoreanTokenizerFactory:
{code:xml}

   
 
  
 
{code}
For KoreanPartOfSpeechStopFilterFactory:
{code:xml}


  
  

 
{code}
For KoreanReadingFormFilterFactory:
{code:xml}

   
 
 
   
 
{code}

> Add example settings to Korean analyzer components' javadocs
> 
>
> Key: LUCENE-8453
> URL: https://issues.apache.org/jira/browse/LUCENE-8453
> Project: Lucene - Core
>  Issue Type: Improvement
>  Components: general/javadocs
>Reporter: Tomoko Uchida
>Priority: Minor
>
> Korean analyzer (nori) javadoc needs example schema settings.
> I'll create a patch.



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)

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



[jira] [Comment Edited] (LUCENE-8453) Add example settings to Korean analyzer components' javadocs

2018-08-10 Thread Tomoko Uchida (JIRA)


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

Tomoko Uchida edited comment on LUCENE-8453 at 8/10/18 10:16 PM:
-

KoreanAnalyzer discards some parameters (for example, KoreanTokenizerFactory 
has additional parameters "userDictionary" and "userDictionaryEncoding".)  I 
think Javadoc examples should include all available parameters so my example 
settings include all parameters which are accepted by 
TokenizerFactory/TokenFilterFactoys.

About LowerCaseFilterFactory, of course it is needed in complete Analyzer 
settings, 

I "feel" Javadoc example should focus on the targeted component only (like 
Kuromoji example settings below.)

[https://lucene.apache.org/core/7_4_0/analyzers-kuromoji/org/apache/lucene/analysis/ja/JapanesePartOfSpeechStopFilterFactory.html]


was (Author: tomoko uchida):
KoreanAnalyzer discards some parameters (for example, KoreanTokenizerFactory 
has additional parameters "userDictionary" and "userDictionaryEncoding")  I 
think Javadoc examples should include all available parameters so my example 
settings include all parameters TokenizerFactory/TokenFilterFactoys accept.

About LowerCaseFilterFactory, of course it is needed in complete Analyzer 
settings, 

I "feel" Javadoc example should focus on the targeted component only (like 
Kuromoji example settings below.)

https://lucene.apache.org/core/7_4_0/analyzers-kuromoji/org/apache/lucene/analysis/ja/JapanesePartOfSpeechStopFilterFactory.html

> Add example settings to Korean analyzer components' javadocs
> 
>
> Key: LUCENE-8453
> URL: https://issues.apache.org/jira/browse/LUCENE-8453
> Project: Lucene - Core
>  Issue Type: Improvement
>  Components: general/javadocs
>Reporter: Tomoko Uchida
>Priority: Minor
>
> Korean analyzer (nori) javadoc needs example schema settings.
> I'll create a patch.



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)

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



[jira] [Comment Edited] (LUCENE-8453) Add example settings to Korean analyzer components' javadocs

2018-08-10 Thread Tomoko Uchida (JIRA)


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

Tomoko Uchida edited comment on LUCENE-8453 at 8/10/18 1:23 PM:


Created a PR. It is based on Kuromoji's examples.

[https://github.com/apache/lucene-solr/pull/434]

Note: I've tested all parameters in this example schemas with CustomAnalyzer, 
but not tested with Solr yet. Check the XML settings with Solr, please.


was (Author: tomoko uchida):
Created a PR. It is based on Kuromoji's examples.

[https://github.com/apache/lucene-solr/pull/434]

Note: I've tested all parameters in this example schemas with CustomAnalyzer, 
but not yet tested with Solr. Check the XML settings with Solr, please.

> Add example settings to Korean analyzer components' javadocs
> 
>
> Key: LUCENE-8453
> URL: https://issues.apache.org/jira/browse/LUCENE-8453
> Project: Lucene - Core
>  Issue Type: Improvement
>  Components: general/javadocs
>Reporter: Tomoko Uchida
>Priority: Minor
>
> Korean analyzer (nori) javadoc needs example schema settings.
> I'll create a patch.



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)

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