doc fixes

rerun-io · Jul 24, 2023 · d70ec97 · d70ec97
1 parent 75091c9
commit d70ec97
Show file tree

Hide file tree

Showing 5 changed files with 9 additions and 26 deletions.
diff --git a/crates/re_components/src/color.rs b/crates/re_components/src/color.rs
@@ -1,13 +1,5 @@
 /// An RGBA color tuple with unmultiplied/separate alpha,
 /// in sRGB gamma space with linear alpha.
-///
-/// ```
-/// use re_types::components::ColorRGBA;
-/// use arrow2_convert::field::ArrowField;
-/// use arrow2::datatypes::{DataType, Field};
-///
-/// assert_eq!(ColorRGBA::data_type(), DataType::UInt32);
-/// ```
 #[derive(
     Clone,
     Copy,

diff --git a/crates/re_components/src/label.rs b/crates/re_components/src/label.rs
@@ -1,14 +1,6 @@
 use arrow2_convert::{ArrowDeserialize, ArrowField, ArrowSerialize};
 
 /// A String label component
-///
-/// ```
-/// use re_components::Label;
-/// use arrow2_convert::field::ArrowField;
-/// use arrow2::datatypes::{DataType, Field};
-///
-/// assert_eq!(Label::data_type(), DataType::Utf8);
-/// ```
 #[derive(Debug, Clone, PartialEq, Eq, ArrowField, ArrowSerialize, ArrowDeserialize)]
 #[cfg_attr(feature = "serde", derive(serde::Deserialize, serde::Serialize))]
 #[arrow_field(transparent)]

diff --git a/crates/re_data_ui/src/component_ui_registry.rs b/crates/re_data_ui/src/component_ui_registry.rs
@@ -39,7 +39,7 @@ pub fn create_component_ui_registry() -> ComponentUiRegistry {
     add::<re_types::components::ClassId>(&mut registry);
     add::<re_types::components::Color>(&mut registry);
     add::<re_types::components::KeypointId>(&mut registry);
-    // add::<re_components::Label>(&mut registry);
+    // add::<re_types::components::Label>(&mut registry);
     add::<re_components::LineStrip2D>(&mut registry);
     add::<re_components::LineStrip3D>(&mut registry);
     add::<re_components::Mesh3D>(&mut registry);

diff --git a/crates/re_query/src/visit.rs b/crates/re_query/src/visit.rs
@@ -7,8 +7,7 @@
 //! # Usage
 //! ```
 //! # use re_query::EntityView;
-//! # use re_components::{ColorRGBA, Point2D};
-//! # use re_types::components::InstanceKey;
+//! # use re_types::components::{Color, Point2D, InstanceKey};
 //!
 //! let instances = InstanceKey::from_iter(0..3);
 //!
@@ -19,9 +18,9 @@
 //! ];
 //!
 //! let colors = [
-//!     ColorRGBA(0),
-//!     ColorRGBA(1),
-//!     ColorRGBA(2),
+//!     Color(0),
+//!     Color(1),
+//!     Color(2),
 //! ];
 //!
 //! let entity_view = EntityView::from_native2(
@@ -30,10 +29,10 @@
 //! );
 //!
 //! let mut points_out = Vec::<Point2D>::new();
-//! let mut colors_out = Vec::<ColorRGBA>::new();
+//! let mut colors_out = Vec::<Color>::new();
 //!
 //! entity_view
-//!     .visit2(|_: InstanceKey, point: Point2D, color: Option<ColorRGBA>| {
+//!     .visit2(|_: InstanceKey, point: Point2D, color: Option<Color>| {
 //!         points_out.push(point);
 //!         colors_out.push(color.unwrap());
 //!     })

diff --git a/crates/rerun/src/lib.rs b/crates/rerun/src/lib.rs
@@ -33,11 +33,11 @@
 //! # use rerun::external::image;
 //! # fn capture_image() -> image::DynamicImage { Default::default() }
 //! # fn positions() -> Vec<rerun::components::Point3D> { Default::default() }
-//! # fn colors() -> Vec<rerun::components::ColorRGBA> { Default::default() }
+//! # fn colors() -> Vec<rerun::components::Color> { Default::default() }
 //! let rec_stream = rerun::RecordingStreamBuilder::new("my_app").buffered()?;
 //!
 //! let points: Vec<rerun::components::Point3D> = positions();
-//! let colors: Vec<rerun::components::ColorRGBA> = colors();
+//! let colors: Vec<rerun::components::Color> = colors();
 //! let image: image::DynamicImage = capture_image();
 //!
 //! rerun::MsgSender::new("points")