Skip to content

Commit

Permalink
addressing PR comments
Browse files Browse the repository at this point in the history
  • Loading branch information
teh-cmc committed Jun 14, 2023
1 parent 0955e07 commit 4d02e6d
Show file tree
Hide file tree
Showing 5 changed files with 10 additions and 5 deletions.
2 changes: 1 addition & 1 deletion crates/re_types/Cargo.toml
Original file line number Diff line number Diff line change
@@ -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
Expand Down
6 changes: 4 additions & 2 deletions crates/re_types/definitions/arrow/attributes.fbs
Original file line number Diff line number Diff line change
Expand Up @@ -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";
2 changes: 1 addition & 1 deletion crates/re_types/definitions/fbs/attributes.fbs
Original file line number Diff line number Diff line change
Expand Up @@ -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!
Expand Down
3 changes: 3 additions & 0 deletions crates/re_types/definitions/fbs/scalars.fbs
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion crates/re_types/source_hash.txt
Original file line number Diff line number Diff line change
@@ -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
dae77f291d1698807cd865265cbb77731bd1aedf07c0968a6b0ac67c18f94590

0 comments on commit 4d02e6d

Please sign in to comment.