Improve map view fbs docstring

rerun-io · Oct 25, 2024 · 045c59a · 045c59a
1 parent 598e25b
commit 045c59a
Show file tree

Hide file tree

Showing 6 changed files with 12 additions and 11 deletions.
diff --git a/crates/store/re_types/definitions/rerun/blueprint/views/map.fbs b/crates/store/re_types/definitions/rerun/blueprint/views/map.fbs
@@ -1,8 +1,8 @@
 namespace rerun.blueprint.views;
 
-/// A map view.
+/// A 2D map view to display geospatial primitives.
 ///
-/// \example views/map title="Use a blueprint to create a MapView."
+/// \example views/map title="Use a blueprint to create a map view."
 //TODO(ab): add a screenshot
 table MapView (
     "attr.rerun.view_identifier": "Map"

diff --git a/crates/store/re_types/src/blueprint/views/map_view.rs b/crates/store/re_types/src/blueprint/views/map_view.rs
diff --git a/crates/viewer/re_space_view_map/src/map_space_view.rs b/crates/viewer/re_space_view_map/src/map_space_view.rs
@@ -80,7 +80,7 @@ impl SpaceViewClass for MapSpaceView {
     fn help_markdown(&self, _egui_ctx: &egui::Context) -> String {
         "# Map view
 
-Displays a Position3D on a map.
+Displays geospatial primitives on a map.
 
 ## Navigation controls
 

diff --git a/docs/content/reference/types/views.md b/docs/content/reference/types/views.md
diff --git a/docs/content/reference/types/views/map_view.md b/docs/content/reference/types/views/map_view.md
diff --git a/rerun_py/rerun_sdk/rerun/blueprint/views/map_view.py b/rerun_py/rerun_sdk/rerun/blueprint/views/map_view.py