Details

    • Type: Wish Wish
    • Status: Closed
    • Priority: Minor Minor
    • Resolution: Fixed
    • Affects Version/s: 2.2
    • Fix Version/s: 2.2
    • Component/s: general/javadocs
    • Labels:
      None
    • Lucene Fields:
      Patch Available

      Description

      Analysis package level javadocs need improving. An overview of what an Analyzer does, and maybe some sample code showing how to write you own Analyzer, Tokenizer and TokenFilter would be really helpful. Bonus would be some discussion on best practices for achieving performance during analysis.

      1. LUCENE-925-GSI-v2.patch
        7 kB
        Grant Ingersoll
      2. LUCENE-925.patch
        4 kB
        Grant Ingersoll
      3. LUCENE-925.patch
        7 kB
        Doron Cohen
      4. LUCENE-925.patch
        7 kB
        Doron Cohen
      5. LUCENE-925.patch
        16 kB
        Doron Cohen

        Activity

        Grant Ingersoll created issue -
        Michael Busch made changes -
        Field Original Value New Value
        Fix Version/s 2.2 [ 12312328 ]
        Grant Ingersoll made changes -
        Assignee Grant Ingersoll [ gsingers ]
        Grant Ingersoll made changes -
        Status Open [ 1 ] In Progress [ 3 ]
        Hide
        Grant Ingersoll added a comment -

        First crack at some Analysis level javadocs. All comments welcome. Could use a bit more on best practices, maybe, but has a good intro, I think, to the main concepts.

        Please let me know of changes by 6/14/07, otherwise I will commit to branch and trunk.

        Show
        Grant Ingersoll added a comment - First crack at some Analysis level javadocs. All comments welcome. Could use a bit more on best practices, maybe, but has a good intro, I think, to the main concepts. Please let me know of changes by 6/14/07, otherwise I will commit to branch and trunk.
        Grant Ingersoll made changes -
        Attachment LUCENE-925.patch [ 12359561 ]
        Hide
        Doron Cohen added a comment -

        Very concise, I like it!

        I fixed two typos and added some more info/text (it is less concise now)

        I am considering adding some further discussion of things like position-Increment, analysis at indexing vs. search, and some simple code snippets - hope to have that tomorrow.

        Show
        Doron Cohen added a comment - Very concise, I like it! I fixed two typos and added some more info/text (it is less concise now ) I am considering adding some further discussion of things like position-Increment, analysis at indexing vs. search, and some simple code snippets - hope to have that tomorrow.
        Doron Cohen made changes -
        Attachment LUCENE-925.patch [ 12359578 ]
        Hide
        Grant Ingersoll added a comment -

        I see your patch, Doron, and raise you one patch.

        Added some info on stemming, etc. and a disclaimer about sentence breaking.

        Show
        Grant Ingersoll added a comment - I see your patch, Doron, and raise you one patch. Added some info on stemming, etc. and a disclaimer about sentence breaking.
        Grant Ingersoll made changes -
        Attachment LUCENE-925-GSI-v2.patch [ 12359589 ]
        Hide
        Doron Cohen added a comment -

        Looks good.
        I shortened the stemming "bikes"/"bike" example and moved it to the stemming bullet.

        Show
        Doron Cohen added a comment - Looks good. I shortened the stemming "bikes"/"bike" example and moved it to the stemming bullet.
        Doron Cohen made changes -
        Attachment LUCENE-925.patch [ 12359622 ]
        Hide
        Grant Ingersoll added a comment -

        Looks good to me.
        I will stand by my commitment to commit sometime tomorrow.

        Show
        Grant Ingersoll added a comment - Looks good to me. I will stand by my commitment to commit sometime tomorrow.
        Hide
        Grant Ingersoll added a comment -

        Committed to branch 2.2 and trunk

        Show
        Grant Ingersoll added a comment - Committed to branch 2.2 and trunk
        Grant Ingersoll made changes -
        Lucene Fields [New]
        Resolution Fixed [ 1 ]
        Status In Progress [ 3 ] Closed [ 6 ]
        Hide
        Doron Cohen added a comment -

        Later than I'd hoped, an extended analysis package doc.
        Reopening this issue b/c can't attache a file without re-opening.

        Show
        Doron Cohen added a comment - Later than I'd hoped, an extended analysis package doc. Reopening this issue b/c can't attache a file without re-opening.
        Doron Cohen made changes -
        Status Closed [ 6 ] Reopened [ 4 ]
        Resolution Fixed [ 1 ]
        Lucene Fields [Patch Available]
        Assignee Grant Ingersoll [ gsingers ] Doron Cohen [ doronc ]
        Hide
        Doron Cohen added a comment -

        Attached adds some code samples and adds these sections:

        • Invoking the Analyzer
        • Indexing Analysis vs. Search Analysis
        • - Field Section Boundaries
        • - Token Position Increments

        As today is the last day to commit javadoc issues I am hoping for some quick feedback...

        Show
        Doron Cohen added a comment - Attached adds some code samples and adds these sections: Invoking the Analyzer Indexing Analysis vs. Search Analysis - Field Section Boundaries - Token Position Increments As today is the last day to commit javadoc issues I am hoping for some quick feedback...
        Doron Cohen made changes -
        Attachment LUCENE-925.patch [ 12359908 ]
        Hide
        Michael Busch added a comment -

        Doron,

        I read the new sections... really good stuff and definitely useful!
        I also like that you added more Wikipedia links.

        My +1 for committing.

        Show
        Michael Busch added a comment - Doron, I read the new sections... really good stuff and definitely useful! I also like that you added more Wikipedia links. My +1 for committing.
        Hide
        Doron Cohen added a comment -

        Great, thanks for reviewing Michael!
        I will commit then.

        Show
        Doron Cohen added a comment - Great, thanks for reviewing Michael! I will commit then.
        Hide
        Doron Cohen added a comment -

        Committed to branch 2.2 and trunk (btw removed few differences between trunk and branch 2.2 for this file).

        Show
        Doron Cohen added a comment - Committed to branch 2.2 and trunk (btw removed few differences between trunk and branch 2.2 for this file).
        Doron Cohen made changes -
        Status Reopened [ 4 ] Resolved [ 5 ]
        Resolution Fixed [ 1 ]
        Michael Busch made changes -
        Status Resolved [ 5 ] Closed [ 6 ]
        Mark Thomas made changes -
        Workflow jira [ 12405835 ] Default workflow, editable Closed status [ 12562539 ]
        Mark Thomas made changes -
        Workflow Default workflow, editable Closed status [ 12562539 ] jira [ 12583504 ]

          People

          • Assignee:
            Doron Cohen
            Reporter:
            Grant Ingersoll
          • Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development