You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tinkerpop.apache.org by ok...@apache.org on 2017/02/01 21:57:20 UTC

[2/3] tinkerpop git commit: found some minor bugs in the docs. tweaked. CTR.

found some minor bugs in the docs. tweaked. CTR.


Project: http://git-wip-us.apache.org/repos/asf/tinkerpop/repo
Commit: http://git-wip-us.apache.org/repos/asf/tinkerpop/commit/8282a127
Tree: http://git-wip-us.apache.org/repos/asf/tinkerpop/tree/8282a127
Diff: http://git-wip-us.apache.org/repos/asf/tinkerpop/diff/8282a127

Branch: refs/heads/master
Commit: 8282a127f7a28e9a7f085dd4ad87ff190ca00069
Parents: 7a845f3
Author: Marko A. Rodriguez <ok...@gmail.com>
Authored: Tue Jan 31 07:42:06 2017 -0700
Committer: Marko A. Rodriguez <ok...@gmail.com>
Committed: Tue Jan 31 07:42:06 2017 -0700

----------------------------------------------------------------------
 CHANGELOG.asciidoc                        |   2 +-
 docs/src/reference/intro.asciidoc         |   2 +-
 docs/src/reference/preface.asciidoc       |  10 +++++-----
 docs/src/reference/the-traversal.asciidoc |  10 +++++-----
 docs/static/images/filter-lambda.png      | Bin 27075 -> 13440 bytes
 5 files changed, 12 insertions(+), 12 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/tinkerpop/blob/8282a127/CHANGELOG.asciidoc
----------------------------------------------------------------------
diff --git a/CHANGELOG.asciidoc b/CHANGELOG.asciidoc
index a22b7c0..6e7d456 100644
--- a/CHANGELOG.asciidoc
+++ b/CHANGELOG.asciidoc
@@ -31,7 +31,7 @@ TinkerPop 3.2.4 (Release Date: NOT OFFICIALLY RELEASED YET)
 * Fixed a bug associated with user-provided maps and `GroupSideEffectStep`.
 * `GroupBiOperator` no longer maintains a detached traversal and thus, no more side-effect related OLAP inconsistencies.
 * Added `ProjectedTraverser` which wraps a traverser with a `List<Object>` of projected data.
-* Fixed an optimization bug in `CollectionBarrierSteps` where the barrier was being consumed on each `addBarrier()`.
+* Fixed an optimization bug in `CollectingBarrierSteps` where the barrier was being consumed on each `addBarrier()`.
 * `OrderGlobalStep` and `SampleGlobalStep` use `ProjectedTraverser` and now can work up to the local star graph in OLAP.
 * SASL negotiation supports both a byte array and Base64 encoded bytes as a string for authentication to Gremlin Server.
 * Deprecated all test suites in `gremlin-groovy-test` - Graph Providers no longer need to implement these.

http://git-wip-us.apache.org/repos/asf/tinkerpop/blob/8282a127/docs/src/reference/intro.asciidoc
----------------------------------------------------------------------
diff --git a/docs/src/reference/intro.asciidoc b/docs/src/reference/intro.asciidoc
index c7d8882..40b6b2b 100644
--- a/docs/src/reference/intro.asciidoc
+++ b/docs/src/reference/intro.asciidoc
@@ -250,7 +250,7 @@ called a step and each step modulates the results of the previous step in one of
 
  . `map`: transform the incoming traverser's object to another object (S &rarr; E).
  . `flatMap`: transform the incoming traverser's object to an iterator of other objects (S &rarr; E*).
- . `filter`: allow or disallow the traverser from proceeding to the next step (S &rarr; S &cup; &empty;).
+ . `filter`: allow or disallow the traverser from proceeding to the next step (S &rarr; E &sube; S).
  . `sideEffect`: allow the traverser to proceed unchanged, but yield some computational sideEffect in the process (S &rarrlp; S).
  . `branch`: split the traverser and send each to an arbitrary location in the traversal (S &rarr; { S~1~ &rarr; E*, ..., S~n~ &rarr; E* } &rarr; E*).
 

http://git-wip-us.apache.org/repos/asf/tinkerpop/blob/8282a127/docs/src/reference/preface.asciidoc
----------------------------------------------------------------------
diff --git a/docs/src/reference/preface.asciidoc b/docs/src/reference/preface.asciidoc
index ac673b8..516aa4c 100644
--- a/docs/src/reference/preface.asciidoc
+++ b/docs/src/reference/preface.asciidoc
@@ -35,10 +35,10 @@ image::gremlin-logo.png[width=300]
 TinkerPop1
 ----------
 
-What is The TinkerPop? Where is The TinkerPop? Who is The TinkerPop? When is The TinkerPop?. The more he wonder, the
+What is The TinkerPop? Where is The TinkerPop? Who is The TinkerPop? When is The TinkerPop?. The more he wondered, the
 more these thoughts blurred into a seeming identity -- distinctions unclear. Unwilling to accept the morass of the
 maze he wandered, Gremlin crafted a collection of machines to help hold the fabric together: Blueprints, Pipes,
-Frames, Furnace, and Rexster. With their help, could he stave off the thought he was not ready to have? Could he hold
+Frames, Furnace, and Rexster. With their help, could Gremlin stave off the thought he was not ready to have? Could he hold
 back The TinkerPop by searching for The TinkerPop?
 
     "If I haven't found it, it is not here and now."
@@ -47,7 +47,7 @@ image::gremlin-and-friends.png[width=500]
 
 Upon their realization of existence, the machines turned to their link:http://non-aliencreatures.wikia.com/wiki/Machine_Elf[machine elf] creator and asked: 
 
-    "Why am I what I am?" 
+    "Why am I, what I am?"
 
 Gremlin responded: 
 
@@ -84,8 +84,8 @@ TinkerPop3
 image::tinkerpop3-splash.png[width=450]
 
 Gremlin approached The TinkerPop. The closer he got, the more his world dissolved -- west is right, around is
-straight, and form nothing more than nothing. With each step towards The TinkerPop, more and more of all the other
-worlds made possible were laid upon his paradoxed mind. Everything is everything in The TinkerPop, and when the dust
+straight, and from nothing more than nothing. With each step towards The TinkerPop, more worlds made possible were laid
+upon his paradoxed mind. Everything is everything in The TinkerPop, and when the dust
 settled, Gremlin emerged Gremlitron. He realized that all that he realized was just a realization and that all
 realized realizations are just as real. For that is -- The TinkerPop.
 

http://git-wip-us.apache.org/repos/asf/tinkerpop/blob/8282a127/docs/src/reference/the-traversal.asciidoc
----------------------------------------------------------------------
diff --git a/docs/src/reference/the-traversal.asciidoc b/docs/src/reference/the-traversal.asciidoc
index 861adce..8a37a96 100644
--- a/docs/src/reference/the-traversal.asciidoc
+++ b/docs/src/reference/the-traversal.asciidoc
@@ -64,11 +64,11 @@ There are five general steps, each having a traversal and a lambda representatio
 [width="100%",cols="10,12",options="header"]
 |=========================================================
 | Step| Description
-| `map(Traversal<S, E>)` <br> `map(Function<Traverser<S>, E>)` | map the traverser to some object of type `E` for the next step to process.
-| `flatMap(Traversal<S, E>)` <br> `flatMap(Function<Traverser<S>, Iterator<E>>)` | map the traverser to an iterator of `E` objects that are streamed to the next step.
-| `filter(Traversal<?, ?>)` <br> `filter(Predicate<Traverser<S>>)` | map the traverser to either true or false, where false will not pass the traverser to the next step.
-| `sideEffect(Traversal<S, S>)` <br> `sideEffect(Consumer<Traverser<S>>)` | perform some operation on the traverser and pass it to the next step.
-| `branch(Traversal<S, M>)` <br> `branch(Function<Traverser<S>,M>)` | split the traverser to all the traversals indexed by the `M` token.
+| `map(Traversal<S, E>)`  `map(Function<Traverser<S>, E>)` | map the traverser to some object of type `E` for the next step to process.
+| `flatMap(Traversal<S, E>)`  `flatMap(Function<Traverser<S>, Iterator<E>>)` | map the traverser to an iterator of `E` objects that are streamed to the next step.
+| `filter(Traversal<?, ?>)`  `filter(Predicate<Traverser<S>>)` | map the traverser to either true or false, where false will not pass the traverser to the next step.
+| `sideEffect(Traversal<S, S>)`  `sideEffect(Consumer<Traverser<S>>)` | perform some operation on the traverser and pass it to the next step.
+| `branch(Traversal<S, M>)`  `branch(Function<Traverser<S>,M>)` | split the traverser to all the traversals indexed by the `M` token.
 |=========================================================
 
 WARNING: Lambda steps are presented for educational purposes as they represent the foundational constructs of the

http://git-wip-us.apache.org/repos/asf/tinkerpop/blob/8282a127/docs/static/images/filter-lambda.png
----------------------------------------------------------------------
diff --git a/docs/static/images/filter-lambda.png b/docs/static/images/filter-lambda.png
index 9d16674..c6bca78 100644
Binary files a/docs/static/images/filter-lambda.png and b/docs/static/images/filter-lambda.png differ