search

rerun-io / rerun

Visualize streams of multimodal data. Free, fast, easy to use, and simple to integrate. Built in Rust.
https://rerun.io/
Apache License 2.0
6.68k stars 338 forks source link

Disconnected space documentation incorrectly suggests reconnection is possible #7121

Open jleibs opened 3 months ago

jleibs commented 3 months ago

See:

https://github.com/rerun-io/rerun/blob/main/crates/store/re_types/definitions/rerun/components/disconnected_space.fbs#L20

  /// Whether the entity path at which this is logged is disconnected from its parent.
  ///
  /// Set to true to disconnect the entity from its parent.
  /// Set to false to disable the effects of this component, (re-)connecting the entity to its parent again.
  is_disconnected: rerun.datatypes.Bool (order: 100);

It would be great to fix this, but if not, we should update the docs.

Wumpf commented 3 months ago

Fixing the documentation issue but keeping this issue open - I know why we made that decision, but practically speaking it's strange to have a boolean component if it only ever tags disconnects indefenitely