You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@lucene.apache.org by GitBox <gi...@apache.org> on 2020/03/23 15:48:58 UTC

[GitHub] [lucene-solr] epugh opened a new pull request #1372: SOLR-14358 Document how to use Processor in JavaDocs

epugh opened a new pull request #1372: SOLR-14358 Document how to use Processor in JavaDocs
URL: https://github.com/apache/lucene-solr/pull/1372
 
 
   
   # Description
   
   There is an existing PR (https://github.com/apache/lucene-solr/pull/404) from 2018 that needed some updates to the JavaDoc formatting.
   
   # Solution
   
   I fixed the formatting.
   
   # Tests
   
   ran `ant documentation`
   
   # Checklist
   
   Please review the following and check all that apply:
   
   - [ X] I have reviewed the guidelines for [How to Contribute](https://wiki.apache.org/solr/HowToContribute) and my code conforms to the standards described there to the best of myx ability.
   - [ x] I have created a Jira issue and added the issue ID to my pull request title.
   - [ X] I have given Solr maintainers [access](https://help.github.com/en/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork) to contribute to my PR branch. (optional but recommended)
   - [ X] I have developed this patch against the `master` branch.
   - [ X] I have run `ant precommit` and the appropriate test suite.
   - [ ] I have added tests for my changes.
   - [ ] I have added documentation for the [Ref Guide](https://github.com/apache/lucene-solr/tree/master/solr/solr-ref-guide) (for Solr changes only).
   

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services

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


[GitHub] [lucene-solr] HoustonPutman commented on issue #1372: SOLR-14358 Document how to use Processor in JavaDocs

Posted by GitBox <gi...@apache.org>.
HoustonPutman commented on issue #1372: SOLR-14358 Document how to use Processor in JavaDocs
URL: https://github.com/apache/lucene-solr/pull/1372#issuecomment-602768597
 
 
   The [URP refguide page](https://lucene.apache.org/solr/guide/8_4/update-request-processors.html#general-use-updateprocessorfactories) links to each of the individual processors' Javadocs. So for now I don't see an issue with this documentation living in the Javadocs, until the documentation for all the processors gets mass-migrated to the ref-guide.

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services

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


[GitHub] [lucene-solr] janhoy commented on issue #1372: SOLR-14358 Document how to use Processor in JavaDocs

Posted by GitBox <gi...@apache.org>.
janhoy commented on issue #1372: SOLR-14358 Document how to use Processor in JavaDocs
URL: https://github.com/apache/lucene-solr/pull/1372#issuecomment-602762093
 
 
   Great! Just wonder if this doc would also fit in the RefGuide? Users will not always care about java docs.
   
   In the example, it would be better if the url_xxx fields were defined as single valued and numeric where it makes sense. A typical use case is to use these for various query boosts. Perhaps that should be mentioned too?

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services

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


[GitHub] [lucene-solr] epugh commented on issue #1372: SOLR-14358 Document how to use Processor in JavaDocs

Posted by GitBox <gi...@apache.org>.
epugh commented on issue #1372: SOLR-14358 Document how to use Processor in JavaDocs
URL: https://github.com/apache/lucene-solr/pull/1372#issuecomment-604678922
 
 
   So @janhoy and @HoustonPutman is there something you want me to change?  Should I tackle the `url_xxx` naming?

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services

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


[GitHub] [lucene-solr] janhoy commented on issue #1372: SOLR-14358 Document how to use Processor in JavaDocs

Posted by GitBox <gi...@apache.org>.
janhoy commented on issue #1372: SOLR-14358 Document how to use Processor in JavaDocs
URL: https://github.com/apache/lucene-solr/pull/1372#issuecomment-604724110
 
 
   Yes, please use single valued int fields for url_length , url_levels , url_toplevel and url_landingpage
   Else, it looks good!

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services

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