You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tinkerpop.apache.org by jo...@apache.org on 2022/02/07 08:49:18 UTC

[tinkerpop] branch 3.5-dev updated: docs: Fix GraphBinary enum like types specification

This is an automated email from the ASF dual-hosted git repository.

jorgebg pushed a commit to branch 3.5-dev
in repository https://gitbox.apache.org/repos/asf/tinkerpop.git


The following commit(s) were added to refs/heads/3.5-dev by this push:
     new a34280d  docs: Fix GraphBinary enum like types specification
     new cbb3bea  Merge pull request #1560 from ihoro/fix-graphbinary-enum-spec
a34280d is described below

commit a34280dc030b6aaffaf36509b60e38dec2da5073
Author: Igor Ostapenko <ih...@users.noreply.github.com>
AuthorDate: Thu Feb 3 20:24:39 2022 +0200

    docs: Fix GraphBinary enum like types specification
    
    Enum like types (Barrier, Cardinality, Column, Direction, Operator, Order,
    Pick, Pop, Scope, T) should provide enum element name as a fully-qualified
    string, i.e. as {type_code}{type_info}{value_flag}{value}.
---
 docs/src/dev/io/graphbinary.asciidoc | 20 ++++++++++----------
 1 file changed, 10 insertions(+), 10 deletions(-)

diff --git a/docs/src/dev/io/graphbinary.asciidoc b/docs/src/dev/io/graphbinary.asciidoc
index ecec755..9403857 100644
--- a/docs/src/dev/io/graphbinary.asciidoc
+++ b/docs/src/dev/io/graphbinary.asciidoc
@@ -356,7 +356,7 @@ properties. Note that as TinkerPop currently send "references" only, this value
 
 ==== Barrier
 
-Format: a single `String` representing the enum value.
+Format: a fully qualified single `String` representing the enum value.
 
 ==== Binding
 
@@ -386,31 +386,31 @@ Where:
 
 ==== Cardinality
 
-Format: a single `String` representing the enum value.
+Format: a fully qualified single `String` representing the enum value.
 
 ==== Column
 
-Format: a single `String` representing the enum value.
+Format: a fully qualified single `String` representing the enum value.
 
 ==== Direction
 
-Format: a single `String` representing the enum value.
+Format: a fully qualified single `String` representing the enum value.
 
 ==== Operator
 
-Format: a single `String` representing the enum value.
+Format: a fully qualified single `String` representing the enum value.
 
 ==== Order
 
-Format: a single `String` representing the enum value.
+Format: a fully qualified single `String` representing the enum value.
 
 ==== Pick
 
-Format: a single `String` representing the enum value.
+Format: a fully qualified single `String` representing the enum value.
 
 ==== Pop
 
-Format: a single `String` representing the enum value.
+Format: a fully qualified single `String` representing the enum value.
 
 ==== Lambda
 
@@ -433,11 +433,11 @@ Where:
 
 ==== Scope
 
-Format: a single `String` representing the enum value.
+Format: a fully qualified single `String` representing the enum value.
 
 ==== T
 
-Format: a single `String` representing the enum value.
+Format: a fully qualified single `String` representing the enum value.
 
 ==== Traverser