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

ASF GitHub Bot commented on TINKERPOP3-908:
-------------------------------------------

Github user dkuppitz commented on the pull request:

    
https://github.com/apache/incubator-tinkerpop/pull/118#issuecomment-150335848
  
    `the-traversal.asciidoc` also worked for me (I didn't try the others as I 
still have to set up my Hadoop 2 environment first; will do that the coming 
weekend). Hence, I can tell that the error mentioned above is not a general 
problem in the docs, but I can't vote yet.


> Use line breaks in documentation
> --------------------------------
>
>                 Key: TINKERPOP3-908
>                 URL: https://issues.apache.org/jira/browse/TINKERPOP3-908
>             Project: TinkerPop 3
>          Issue Type: Improvement
>          Components: documentation
>    Affects Versions: 3.0.2-incubating
>            Reporter: stephen mallette
>            Assignee: stephen mallette
>
> It wasn't realized early on that asciidoc would respect line breaks (as being 
> a single paragraph) in documentation so we tended to rely on intellij for 
> artificial line breaks.  The problem with that approach was that if a single 
> letter changed in the docs within a paragraph it wasn't easy to see in a git 
> diff what the change was because the whole line would be seen as a diff.  
> This also made merging docs more difficult.



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)

Reply via email to