[ 
https://issues.apache.org/jira/browse/OPENNLP-32?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16878826#comment-16878826
 ] 

ASF GitHub Bot commented on OPENNLP-32:
---------------------------------------

rdorado commented on pull request #359: OPENNLP-32: Added a short description 
of parsing and parse tree with …
URL: https://github.com/apache/opennlp/pull/359
 
 
   Thank you for contributing to Apache OpenNLP.
   
   In order to streamline the review of the contribution we ask you
   to ensure the following steps have been taken:
   
   ### For all changes:
   - [ x ] Is there a JIRA ticket associated with this PR? Is it referenced 
        in the commit message?
   
   - [ x ] Does your PR title start with OPENNLP-XXXX where XXXX is the JIRA 
number you are trying to resolve? Pay particular attention to the hyphen "-" 
character.
   
   - [ x ] Has your PR been rebased against the latest commit within the target 
branch (typically master)?
   
   - [ ] Is your initial contribution a single, squashed commit?
   
   
   ### For documentation related changes:
   - [ x ] Have you ensured that format looks appropriate for the output in 
which it is rendered?
   
   ### Note:
   Please ensure that once the PR is submitted, you check travis-ci for build 
issues and submit an update to your PR as soon as possible.
   
 
----------------------------------------------------------------
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:
[email protected]


> Write more documentation for the parser
> ---------------------------------------
>
>                 Key: OPENNLP-32
>                 URL: https://issues.apache.org/jira/browse/OPENNLP-32
>             Project: OpenNLP
>          Issue Type: Improvement
>          Components: Documentation
>            Reporter: Joern Kottmann
>            Priority: Major
>              Labels: help-wanted
>
> 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



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)

Reply via email to