Solr
  1. Solr
  2. SOLR-389

RequestHandlerBase javadocs improvement

    Details

    • Type: Improvement Improvement
    • Status: Resolved
    • Priority: Trivial Trivial
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: None
    • Component/s: documentation
    • Labels:
      None

      Description

      Provide more javadocs on RequestHandlerBase#.init(NamedList) method to explain about the defaults, appends and invariants

      1. SOLR-389.patch
        3 kB
        Grant Ingersoll
      2. SOLR-389.patch
        3 kB
        Grant Ingersoll

        Activity

        Ryan McKinley made changes -
        Status In Progress [ 3 ] Resolved [ 5 ]
        Resolution Fixed [ 1 ]
        Hide
        Ryan McKinley added a comment -

        commited a while back. Thanks Grant

        Show
        Ryan McKinley added a comment - commited a while back. Thanks Grant
        Hide
        Grant Ingersoll added a comment -

        It should be done, pending your review.

        Show
        Grant Ingersoll added a comment - It should be done, pending your review.
        Hide
        Ryan McKinley added a comment -

        I will delete:
        http://wiki.apache.org/solr/RequestHandlerBase

        to avoid the duplicate docs

        Show
        Ryan McKinley added a comment - I will delete: http://wiki.apache.org/solr/RequestHandlerBase to avoid the duplicate docs
        Ryan Shurr committed 589442 (1 file)
        Reviews: none

        SOLR-389 -- adding better javadocs for RequestHandlerBase -- thanks Grant!

        Ryan McKinley made changes -
        Assignee Grant Ingersoll [ gsingers ] Ryan McKinley [ ryantxu ]
        Hide
        Ryan McKinley added a comment -

        Thanks Grant

        Do you want me to commit this now? Is it still "In Progress" (I have not seen people use that status before, does it mean you are still working on it?)

        Show
        Ryan McKinley added a comment - Thanks Grant Do you want me to commit this now? Is it still "In Progress" (I have not seen people use that status before, does it mean you are still working on it?)
        Grant Ingersoll made changes -
        Attachment SOLR-389.patch [ 12368221 ]
        Hide
        Grant Ingersoll added a comment -

        Changed @see method to point to SolrPluginUtils instead of U#setDefaults

        Show
        Grant Ingersoll added a comment - Changed @see method to point to SolrPluginUtils instead of U#setDefaults
        Grant Ingersoll made changes -
        Attachment SOLR-389.patch [ 12368219 ]
        Hide
        Grant Ingersoll added a comment -

        First draft of javadocs for RequestHandlerBase#init method explaining the use of defaults, invariants and appends parameters.

        Show
        Grant Ingersoll added a comment - First draft of javadocs for RequestHandlerBase#init method explaining the use of defaults, invariants and appends parameters.
        Grant Ingersoll made changes -
        Field Original Value New Value
        Status Open [ 1 ] In Progress [ 3 ]
        Grant Ingersoll created issue -

          People

          • Assignee:
            Ryan McKinley
            Reporter:
            Grant Ingersoll
          • Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development