[arrow] branch master updated: ARROW-5313: [Format] Comments on Field table are a bit confusing

[em...@apache.org]

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

emkornfield pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/arrow.git


The following commit(s) were added to refs/heads/master by this push:
     new 9d3b62a  ARROW-5313: [Format] Comments on Field table are a bit confusing
9d3b62a is described below

commit 9d3b62a5540261b1bd4fbd9510ee660a04b3e231
Author: Brian Hulette <bh...@google.com>
AuthorDate: Wed May 15 16:29:09 2019 -0700

    ARROW-5313: [Format] Comments on Field table are a bit confusing
    
    Move comments about specific attributes of `Field` into the definition to avoid confusion.
    
    Author: Brian Hulette <bh...@google.com>
    
    Closes #4306 from TheNeuralBit/fbs-field-comment and squashes the following commits:
    
    f500fd5e <Brian Hulette> triple-slash comments
    a13b8ee2 <Brian Hulette> Clarify comment on Field table
---
 format/Schema.fbs | 20 ++++++++++----------
 1 file changed, 10 insertions(+), 10 deletions(-)

diff --git a/format/Schema.fbs b/format/Schema.fbs
index 9e52a8d..3f26e95 100644
--- a/format/Schema.fbs
+++ b/format/Schema.fbs
@@ -243,25 +243,25 @@ table DictionaryEncoding {
 /// ----------------------------------------------------------------------
 /// A field represents a named column in a record / row batch or child of a
 /// nested type.
-///
-/// - children is only for nested Arrow arrays
-/// - For primitive types, children will have length 0
-/// - nullable should default to true in general
 
 table Field {
-  // Name is not required, in i.e. a List
+  /// Name is not required, in i.e. a List
   name: string;
+
+  /// Whether or not this field can contain nulls. Should be true in general.
   nullable: bool;
-  // This is the type of the decoded value if the field is dictionary encoded
+
+  /// This is the type of the decoded value if the field is dictionary encoded.
   type: Type;
 
-  // Present only if the field is dictionary encoded
+  /// Present only if the field is dictionary encoded.
   dictionary: DictionaryEncoding;
 
-  // children apply only to Nested data types like Struct, List and Union
-  children: [Field];
+  /// children apply only to nested data types like Struct, List and Union. For
+  /// primitive types children will have length 0.
+  children: [ Field ];
 
-  // User-defined metadata
+  /// User-defined metadata
   custom_metadata: [ KeyValue ];
 }