Lucene - Core
  1. Lucene - Core
  2. LUCENE-5392

Documentation for modified token / analysis pipeline

    Details

    • Type: Bug Bug
    • Status: Closed
    • Priority: Major Major
    • Resolution: Fixed
    • Affects Version/s: Trunk
    • Fix Version/s: 5.0, Trunk
    • Component/s: None
    • Labels:
      None
    • Lucene Fields:
      New

      Description

      The changes to the tokenizer and analyzer need to be reflected in the package overview for core analysis.

        Activity

        Hide
        Anshum Gupta added a comment -

        Bulk close after 5.0 release.

        Show
        Anshum Gupta added a comment - Bulk close after 5.0 release.
        Hide
        ASF subversion and git services added a comment -

        Commit 1557158 from Robert Muir in branch 'dev/trunk'
        [ https://svn.apache.org/r1557158 ]

        LUCENE-5392: add/improve analysis package docs to reflect API changes in trunk (closes #17)

        Show
        ASF subversion and git services added a comment - Commit 1557158 from Robert Muir in branch 'dev/trunk' [ https://svn.apache.org/r1557158 ] LUCENE-5392 : add/improve analysis package docs to reflect API changes in trunk (closes #17)
        Hide
        Robert Muir added a comment -

        I'm running the checks on this patch, it looks good.

        A few bugs (the first is just a typo, the other two cross-module links need a javadocs-hack)

        {@link org.apache.lucene.analysis.CharFilters} -> {@link org.apache.lucene.analysis.CharFilter}s,
        {@link org.apache.lucene.analysis.standard.StandardAnalyzer} -> <a href="{@docRoot}/../analyzers-common/org/apache/lucene/analysis/standard/StandardAnalyzer.html">StandardAnalyzer</a>
        {@link org.apache.lucene.analysis.miscellaneous.PerFieldAnalyzerWrapper} -> <a href="{@docRoot}/../analyzers-common/org/apache/lucene/analysis/miscellaneous/PerFieldAnalyzerWrapper.html">PerFieldAnalyzerWrapper</a>
        

        I also added a short blurb to MIGRATE.txt in trunk to explain the change. Currently it just points them at the package documentation for more details:

        +
        +## Removed Reader from Tokenizer constructor (LUCENE-5388)
        +
        +The constructor of Tokenizer no longer takes Reader, as this was a leftover
        +from before it was reusable. See the org.apache.lucene.analysis package
        +documentation for more details.
        

        I'm running full documentation-lint checks now, when it passes ill commit. Thanks Benson!

        Show
        Robert Muir added a comment - I'm running the checks on this patch, it looks good. A few bugs (the first is just a typo, the other two cross-module links need a javadocs-hack) {@link org.apache.lucene.analysis.CharFilters} -> {@link org.apache.lucene.analysis.CharFilter}s, {@link org.apache.lucene.analysis.standard.StandardAnalyzer} -> <a href="{@docRoot}/../analyzers-common/org/apache/lucene/analysis/standard/StandardAnalyzer.html">StandardAnalyzer</a> {@link org.apache.lucene.analysis.miscellaneous.PerFieldAnalyzerWrapper} -> <a href="{@docRoot}/../analyzers-common/org/apache/lucene/analysis/miscellaneous/PerFieldAnalyzerWrapper.html">PerFieldAnalyzerWrapper</a> I also added a short blurb to MIGRATE.txt in trunk to explain the change. Currently it just points them at the package documentation for more details: + +## Removed Reader from Tokenizer constructor (LUCENE-5388) + +The constructor of Tokenizer no longer takes Reader, as this was a leftover +from before it was reusable. See the org.apache.lucene.analysis package +documentation for more details. I'm running full documentation-lint checks now, when it passes ill commit. Thanks Benson!
        Hide
        Uwe Schindler added a comment -

        Thanks for the updates. The code examples get out of date very easy, because we cannot check the automatically.

        Show
        Uwe Schindler added a comment - Thanks for the updates. The code examples get out of date very easy, because we cannot check the automatically.
        Hide
        Benson Margulies added a comment -

        https://github.com/apache/lucene-solr/pull/17

        Robert Muir and Uwe Schindler 'Look out below', here's a bunch of work on the analysis doc.

        Show
        Benson Margulies added a comment - https://github.com/apache/lucene-solr/pull/17 Robert Muir and Uwe Schindler 'Look out below', here's a bunch of work on the analysis doc.

          People

          • Assignee:
            Unassigned
            Reporter:
            Benson Margulies
          • Votes:
            0 Vote for this issue
            Watchers:
            4 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development