From 5c7bea0e7b817cd4abdaaebb74005f533920230a Mon Sep 17 00:00:00 2001 From: Andreas Reich Date: Wed, 23 Oct 2024 15:18:25 +0200 Subject: [PATCH] doc fixes --- .../re_types/definitions/rerun/archetypes/asset3d.fbs | 4 ++-- crates/store/re_types/src/archetypes/asset3d.rs | 8 ++++---- crates/viewer/re_viewer/src/reflection/mod.rs | 2 +- rerun_cpp/src/rerun/archetypes/asset3d.hpp | 8 ++++---- rerun_py/rerun_sdk/rerun/archetypes/asset3d.py | 4 ++-- 5 files changed, 13 insertions(+), 13 deletions(-) diff --git a/crates/store/re_types/definitions/rerun/archetypes/asset3d.fbs b/crates/store/re_types/definitions/rerun/archetypes/asset3d.fbs index bb7d26ce3816..b0625fbf2ff6 100644 --- a/crates/store/re_types/definitions/rerun/archetypes/asset3d.fbs +++ b/crates/store/re_types/definitions/rerun/archetypes/asset3d.fbs @@ -38,7 +38,7 @@ table Asset3D ( /// A color multiplier applied to the whole asset. /// - /// For mesh who already have albedo_factor in materials, - /// it will be overwritten by actual albedo_factor of Asset3D (if specified). + /// For mesh who already have `albedo_factor` in materials, + /// it will be overwritten by actual `albedo_factor` of [archetypes.Asset3D] (if specified). albedo_factor: rerun.components.AlbedoFactor ("attr.rerun.component_optional", nullable, order: 3100); } diff --git a/crates/store/re_types/src/archetypes/asset3d.rs b/crates/store/re_types/src/archetypes/asset3d.rs index f0eab8649d4c..5983dff798c7 100644 --- a/crates/store/re_types/src/archetypes/asset3d.rs +++ b/crates/store/re_types/src/archetypes/asset3d.rs @@ -73,8 +73,8 @@ pub struct Asset3D { /// A color multiplier applied to the whole asset. /// - /// For mesh who already have albedo_factor in materials, - /// it will be overwritten by actual albedo_factor of Asset3D (if specified). + /// For mesh who already have `albedo_factor` in materials, + /// it will be overwritten by actual `albedo_factor` of [`archetypes::Asset3D`][crate::archetypes::Asset3D] (if specified). pub albedo_factor: Option, } @@ -266,8 +266,8 @@ impl Asset3D { /// A color multiplier applied to the whole asset. /// - /// For mesh who already have albedo_factor in materials, - /// it will be overwritten by actual albedo_factor of Asset3D (if specified). + /// For mesh who already have `albedo_factor` in materials, + /// it will be overwritten by actual `albedo_factor` of [`archetypes::Asset3D`][crate::archetypes::Asset3D] (if specified). #[inline] pub fn with_albedo_factor( mut self, diff --git a/crates/viewer/re_viewer/src/reflection/mod.rs b/crates/viewer/re_viewer/src/reflection/mod.rs index 67d5962b7eb4..245825156a81 100644 --- a/crates/viewer/re_viewer/src/reflection/mod.rs +++ b/crates/viewer/re_viewer/src/reflection/mod.rs @@ -811,7 +811,7 @@ fn generate_archetype_reflection() -> ArchetypeReflectionMap { is_required : false, }, ArchetypeFieldReflection { component_name : "rerun.components.AlbedoFactor".into(), display_name : "Albedo factor", docstring_md : - "A color multiplier applied to the whole asset.\n\nFor mesh who already have albedo_factor in materials,\nit will be overwritten by actual albedo_factor of Asset3D (if specified).", + "A color multiplier applied to the whole asset.\n\nFor mesh who already have `albedo_factor` in materials,\nit will be overwritten by actual `albedo_factor` of [`archetypes.Asset3D`](https://rerun.io/docs/reference/types/archetypes/asset3d) (if specified).", is_required : false, }, ], }, diff --git a/rerun_cpp/src/rerun/archetypes/asset3d.hpp b/rerun_cpp/src/rerun/archetypes/asset3d.hpp index 33442f36f97d..05ee83b58192 100644 --- a/rerun_cpp/src/rerun/archetypes/asset3d.hpp +++ b/rerun_cpp/src/rerun/archetypes/asset3d.hpp @@ -69,8 +69,8 @@ namespace rerun::archetypes { /// A color multiplier applied to the whole asset. /// - /// For mesh who already have albedo_factor in materials, - /// it will be overwritten by actual albedo_factor of Asset3D (if specified). + /// For mesh who already have `albedo_factor` in materials, + /// it will be overwritten by actual `albedo_factor` of `archetypes::Asset3D` (if specified). std::optional albedo_factor; public: @@ -128,8 +128,8 @@ namespace rerun::archetypes { /// A color multiplier applied to the whole asset. /// - /// For mesh who already have albedo_factor in materials, - /// it will be overwritten by actual albedo_factor of Asset3D (if specified). + /// For mesh who already have `albedo_factor` in materials, + /// it will be overwritten by actual `albedo_factor` of `archetypes::Asset3D` (if specified). Asset3D with_albedo_factor(rerun::components::AlbedoFactor _albedo_factor) && { albedo_factor = std::move(_albedo_factor); // See: https://github.com/rerun-io/rerun/issues/4027 diff --git a/rerun_py/rerun_sdk/rerun/archetypes/asset3d.py b/rerun_py/rerun_sdk/rerun/archetypes/asset3d.py index cf887f3d6dd0..2f0d74c87bcc 100644 --- a/rerun_py/rerun_sdk/rerun/archetypes/asset3d.py +++ b/rerun_py/rerun_sdk/rerun/archetypes/asset3d.py @@ -105,8 +105,8 @@ def _clear(cls) -> Asset3D: ) # A color multiplier applied to the whole asset. # - # For mesh who already have albedo_factor in materials, - # it will be overwritten by actual albedo_factor of Asset3D (if specified). + # For mesh who already have `albedo_factor` in materials, + # it will be overwritten by actual `albedo_factor` of [`archetypes.Asset3D`][rerun.archetypes.Asset3D] (if specified). # # (Docstring intentionally commented out to hide this field from the docs)