OpenNLP
  1. OpenNLP
  2. OPENNLP-32

Write more documentation for the parser

    Details

    • Type: Improvement Improvement
    • Status: Open
    • Priority: Major Major
    • Resolution: Unresolved
    • Affects Version/s: None
    • Fix Version/s: None
    • Component/s: Documentation
    • Labels:
      None

      Description

      Write more documentation for the parser. It should cover the same topic as the
      documentation for the other components.

      The following sections are still missing:

      • No general introduction, it should be explained what parsing is, ideally with a few images
        of parse trees
      • Explain how to navigate in the parse tree with the Parse class, that should be
        explained based on a sample parse tree
      • Add a section about how the training api can be used
      • Remove all todos, and open jira issues for them if they are not solved with this issue

        Activity

        Joern Kottmann created issue -
        Joern Kottmann made changes -
        Field Original Value New Value
        Description Write more documentation for the parser. It should cover the same topic as the
        documentation for the other components.
        Write more documentation for the parser. It should cover the same topic as the
        documentation for the other components.

        The following sections are still missing:
        - No general introduction, it should be explained what parsing is, ideally with a few images
          of parse trees
        - Explain how to navigate in the parse tree with the Parse class, that should be
          explained based on a sample parse tree
        - Add a section about how the training api can be used
        - Remove all todos, and open jira issues for them if they are not solved with this issue
        Joern Kottmann made changes -
        Assignee Jason Baldridge [ jbaldrid ]
        Jason Baldridge made changes -
        Assignee Jason Baldridge [ jbaldrid ]

          People

          • Assignee:
            Unassigned
            Reporter:
            Joern Kottmann
          • Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

            • Created:
              Updated:

              Development