From 4d02e6dedc1234b7f1caefc1bbab72d7d5c783d2 Mon Sep 17 00:00:00 2001 From: Clement Rey Date: Wed, 14 Jun 2023 11:04:32 +0200 Subject: [PATCH] addressing PR comments --- crates/re_types/Cargo.toml | 2 +- crates/re_types/definitions/arrow/attributes.fbs | 6 ++++-- crates/re_types/definitions/fbs/attributes.fbs | 2 +- crates/re_types/definitions/fbs/scalars.fbs | 3 +++ crates/re_types/source_hash.txt | 2 +- 5 files changed, 10 insertions(+), 5 deletions(-) diff --git a/crates/re_types/Cargo.toml b/crates/re_types/Cargo.toml index e3b1b9dc1b2a..4da294c84c50 100644 --- a/crates/re_types/Cargo.toml +++ b/crates/re_types/Cargo.toml @@ -1,7 +1,7 @@ [package] name = "re_types" authors.workspace = true -description = "The standard Rerun data types, component types, and archetypes." +description = "The built-in Rerun data types, component types, and archetypes." edition.workspace = true homepage.workspace = true include.workspace = true diff --git a/crates/re_types/definitions/arrow/attributes.fbs b/crates/re_types/definitions/arrow/attributes.fbs index 33c81c7dfb59..f8e96e4d8bad 100644 --- a/crates/re_types/definitions/arrow/attributes.fbs +++ b/crates/re_types/definitions/arrow/attributes.fbs @@ -2,14 +2,16 @@ namespace arrow; /// Marks a union as sparse, affecting its Arrow datatype. /// -/// This does _not_ affect the object generated in Python or Rust, this is a pure Arrow concern! +/// This does _not_ affect the generated object structure in and of itself, it is a pure Arrow +/// matter that only impacts (de)serialization. /// /// Only applies to unions. attribute "arrow.attr.sparse_union"; /// Marks a single-field object as transparent, affecting its Arrow datatype. /// -/// This does _not_ affect the object generated in Python or Rust, this is a pure Arrow concern! +/// This does _not_ affect the generated object structure in and of itself, it is a pure Arrow +/// matter that only impacts (de)serialization. /// /// This is generally most useful for getting rid of extraneous `struct` layers. attribute "arrow.attr.transparent"; diff --git a/crates/re_types/definitions/fbs/attributes.fbs b/crates/re_types/definitions/fbs/attributes.fbs index cdf311181ef6..d431691e8d96 100644 --- a/crates/re_types/definitions/fbs/attributes.fbs +++ b/crates/re_types/definitions/fbs/attributes.fbs @@ -6,7 +6,7 @@ namespace fbs.attributes; /// This defines a stable order between objects of the same kind, e.g. the order in which fields of a /// struct should be laid out when generating code. /// This is always required since flatbuffers works entirely with unordered maps internally, which -/// would results in flaky code generation. +/// would result in flaky code generation. /// /// In unions, this effectively defines the arrow tag of each variant, since the tag depends on the /// fields's order in the datatype! diff --git a/crates/re_types/definitions/fbs/scalars.fbs b/crates/re_types/definitions/fbs/scalars.fbs index bb6fcd75063b..085df42e26db 100644 --- a/crates/re_types/definitions/fbs/scalars.fbs +++ b/crates/re_types/definitions/fbs/scalars.fbs @@ -2,6 +2,9 @@ /// first. /// This package provides pre-wrapped scalars that will be automatically flattened down to their /// inner type by our parsers. +/// +/// Look e.g. for `fbs.scalars.Float32` in `objects.rs` to see this flatenning in action. + namespace fbs.scalars; /// Flattens down to a 32-bit float. diff --git a/crates/re_types/source_hash.txt b/crates/re_types/source_hash.txt index 1096244fad32..a5681461859d 100644 --- a/crates/re_types/source_hash.txt +++ b/crates/re_types/source_hash.txt @@ -1,4 +1,4 @@ # This is a sha256 hash for all direct and indirect dependencies of this crate's build script. # It can be safely removed at anytime to force the build script to run again. # Check out build.rs to see how it's computed. -e264658cf8184bcb9dbd1302910072b755ea7901e6337b3b5394094ca67e0ef7 \ No newline at end of file +dae77f291d1698807cd865265cbb77731bd1aedf07c0968a6b0ac67c18f94590 \ No newline at end of file