[
https://issues.apache.org/jira/browse/TINKERPOP3-908?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14968934#comment-14968934
]
ASF GitHub Bot commented on TINKERPOP3-908:
-------------------------------------------
GitHub user spmallette opened a pull request:
https://github.com/apache/incubator-tinkerpop/pull/118
TINKERPOP3-908 Use line breaks in documentation
This PR isn't ready for VOTE. I opened this PR more for collaboration.
While all the line breaks have been added, there is a problem in doc generation
I can't figure out with: `the-traversal.asciidoc`. Doc generation is failing
there.
@dkuppitz can you please take a look - i'm just not seeing what's wrong.
Once we get the docs generating, we can put this PR up for VOTE
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/apache/incubator-tinkerpop TINKERPOP3-908
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/incubator-tinkerpop/pull/118.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #118
----
commit cad968e2ad85ba8645de5c133827f59fbe8ac0f5
Author: Stephen Mallette <[email protected]>
Date: 2015-10-22T10:24:18Z
TINKERPOP3-907 Added line breaks to all docs.
Getting a failure on the-traversal during doc generation, but not sure what
the problems is.
commit 7bf9b0952476218a47589781a57b551060f8ce5d
Author: Stephen Mallette <[email protected]>
Date: 2015-10-22T10:32:56Z
Trying an empty commit to see if it will force the branch to synch with
mirror.
----
> 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)
