You are viewing a plain text version of this content. The canonical link for it is here.

Posted to dev@tinkerpop.apache.org by "stephen mallette (JIRA)" <ji...@apache.org> on 2015/10/22 12:23:27 UTC

[jira] [Created] (TINKERPOP3-908) Use line breaks in documentation

stephen mallette created TINKERPOP3-908:
-------------------------------------------

             Summary: 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)