Skip to content

Commit

Permalink
ARROW-5313: [Format] Comments on Field table are a bit confusing
Browse files Browse the repository at this point in the history
Move comments about specific attributes of `Field` into the definition to avoid confusion.

Author: Brian Hulette <[email protected]>

Closes apache#4306 from TheNeuralBit/fbs-field-comment and squashes the following commits:

f500fd5 <Brian Hulette> triple-slash comments
a13b8ee <Brian Hulette> Clarify comment on Field table
  • Loading branch information
TheNeuralBit authored and emkornfield committed May 15, 2019
1 parent dc13c6c commit 9d3b62a
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions format/Schema.fbs
Original file line number Diff line number Diff line change
Expand Up @@ -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 ];
}

Expand Down

0 comments on commit 9d3b62a

Please sign in to comment.