You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tinkerpop.apache.org by sp...@apache.org on 2019/06/14 11:38:34 UTC
[tinkerpop] branch master updated (a2fb0a8 -> c328536)
This is an automated email from the ASF dual-hosted git repository.
spmallette pushed a change to branch master
in repository https://gitbox.apache.org/repos/asf/tinkerpop.git.
from a2fb0a8 Merge branch 'tp34'
new ddac926 Added asciidoc tips/fixes to dev docs
new 31f9572 Merge branch 'tp33' into tp34
new c328536 Merge branch 'tp34'
The 3 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
docs/src/dev/developer/for-committers.asciidoc | 27 ++++++++++++++++++++++++++
1 file changed, 27 insertions(+)
[tinkerpop] 03/03: Merge branch 'tp34'
Posted by sp...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
spmallette pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/tinkerpop.git
commit c3285366490362a5247d8f12705d579ef71781f2
Merge: a2fb0a8 31f9572
Author: Stephen Mallette <sp...@genoprime.com>
AuthorDate: Fri Jun 14 07:38:24 2019 -0400
Merge branch 'tp34'
docs/src/dev/developer/for-committers.asciidoc | 27 ++++++++++++++++++++++++++
1 file changed, 27 insertions(+)
[tinkerpop] 02/03: Merge branch 'tp33' into tp34
Posted by sp...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
spmallette pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/tinkerpop.git
commit 31f95722fdaba01ae9230b980a41535b1e87ea15
Merge: 1271895 ddac926
Author: Stephen Mallette <sp...@genoprime.com>
AuthorDate: Fri Jun 14 07:38:12 2019 -0400
Merge branch 'tp33' into tp34
docs/src/dev/developer/for-committers.asciidoc | 27 ++++++++++++++++++++++++++
1 file changed, 27 insertions(+)
[tinkerpop] 01/03: Added asciidoc tips/fixes to dev docs
Posted by sp...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
spmallette pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/tinkerpop.git
commit ddac926ca8f22239e83658ffee65ec2415b3b838
Author: Stephen Mallette <sp...@genoprime.com>
AuthorDate: Fri Jun 14 07:37:19 2019 -0400
Added asciidoc tips/fixes to dev docs
https://lists.apache.org/thread.html/6b2b9bdba6532de7a84011b003cefc03d26301a912816c78c159b548@%3Cdev.tinkerpop.apache.org%3E CTR
---
docs/src/dev/developer/for-committers.asciidoc | 27 ++++++++++++++++++++++++++
1 file changed, 27 insertions(+)
diff --git a/docs/src/dev/developer/for-committers.asciidoc b/docs/src/dev/developer/for-committers.asciidoc
index 674d009..d4812ea 100644
--- a/docs/src/dev/developer/for-committers.asciidoc
+++ b/docs/src/dev/developer/for-committers.asciidoc
@@ -663,6 +663,33 @@ uploaded to the server and should preserve the directory structure in git as ref
Please see the <<building-testing,Building and Testing>> section for more information on how to generate the
documentation.
+=== Asciidoc Formatting Tips
+
+*Use Asciidoctor*
+
+Asciidoc may render differently with different tools. What may look proper and correct with an IDE may be different
+than what is ultimately generated during the official build of the documentation which uses Asciidoctor. As a result
+it's best to not rely on any other view of changes besides one generated by Asciidoctor.
+
+*Anonymous Traversal Formatting*
+
+The double underscore (i.e. `+__+`) does not typically render right and requires such code to be wrapped with
+`pass:[`pass:[__]`]` or `pass:[`+__+`]`.
+
+Cause: link:https://github.com/asciidoctor/asciidoctor/issues/1717[#1717],
+link:https://github.com/asciidoctor/asciidoctor/issues/1066[#1066]
+
+*Non-whitespace After Backtick*
+
+Use double backtick if there is non-whitespace immediately following the trailing backtick. So rather than:
+pass:[`ScriptInputFormat`'s], prefer pass:[``ScriptInputFormat``'s].
+
+Original: [...] globally available for `ScriptInputFormat`'s `parse()` method
+
+Fixed: [...] globally available for ``ScriptInputFormat``'s `parse()` method
+
+Cause: link:https://github.com/asciidoctor/asciidoctor/issues/1514[#1514]
+
[[site]]
== Site