From 9625594060b048d6802a5c95c543a23fd4b59ccc Mon Sep 17 00:00:00 2001 From: Antoine Beyeler Date: Fri, 25 Oct 2024 15:57:34 +0200 Subject: [PATCH] mark all fbs as unreleased --- .../re_types/definitions/rerun/archetypes/geo_points.fbs | 3 ++- .../rerun/blueprint/archetypes/map_background.fbs | 3 ++- .../definitions/rerun/blueprint/archetypes/map_zoom.fbs | 3 ++- .../rerun/blueprint/components/map_provider.fbs | 3 ++- .../definitions/rerun/blueprint/components/zoom_level.fbs | 3 ++- .../re_types/definitions/rerun/blueprint/views/map.fbs | 3 ++- .../re_types/definitions/rerun/components/latlon.fbs | 3 ++- .../store/re_types/definitions/rerun/datatypes/dvec2d.fbs | 3 ++- docs/content/reference/types/archetypes/geo_points.md | 6 +++--- docs/content/reference/types/components/color.md | 2 +- docs/content/reference/types/components/lat_lon.md | 8 ++++---- docs/content/reference/types/components/radius.md | 2 +- docs/content/reference/types/datatypes/dvec2d.md | 8 ++++---- docs/content/reference/types/views/map_view.md | 2 +- 14 files changed, 30 insertions(+), 22 deletions(-) diff --git a/crates/store/re_types/definitions/rerun/archetypes/geo_points.fbs b/crates/store/re_types/definitions/rerun/archetypes/geo_points.fbs index 4c54d6b5e78e..9402342ceaac 100644 --- a/crates/store/re_types/definitions/rerun/archetypes/geo_points.fbs +++ b/crates/store/re_types/definitions/rerun/archetypes/geo_points.fbs @@ -9,7 +9,8 @@ namespace rerun.archetypes; table GeoPoints ( "attr.rust.derive": "PartialEq", "attr.docs.category": "Geospatial", - "attr.docs.view_types": "MapView" + "attr.docs.view_types": "MapView", + "attr.docs.unreleased" ) { // --- Required --- diff --git a/crates/store/re_types/definitions/rerun/blueprint/archetypes/map_background.fbs b/crates/store/re_types/definitions/rerun/blueprint/archetypes/map_background.fbs index 698ce8fd798a..1d692e7ea74e 100644 --- a/crates/store/re_types/definitions/rerun/blueprint/archetypes/map_background.fbs +++ b/crates/store/re_types/definitions/rerun/blueprint/archetypes/map_background.fbs @@ -3,7 +3,8 @@ namespace rerun.blueprint.archetypes; /// Configuration for the background map of the map view. table MapBackground ( - "attr.rerun.scope": "blueprint" + "attr.rerun.scope": "blueprint", + "attr.docs.unreleased" ) { // --- Optional --- diff --git a/crates/store/re_types/definitions/rerun/blueprint/archetypes/map_zoom.fbs b/crates/store/re_types/definitions/rerun/blueprint/archetypes/map_zoom.fbs index 4d7719158016..0f1488034ac5 100644 --- a/crates/store/re_types/definitions/rerun/blueprint/archetypes/map_zoom.fbs +++ b/crates/store/re_types/definitions/rerun/blueprint/archetypes/map_zoom.fbs @@ -4,7 +4,8 @@ namespace rerun.blueprint.archetypes; /// Configuration of the map view zoom level. //TODO(ab): Turn this archetype into `MapArea` and include a `center: LatLon` componnent or similar table MapZoom ( - "attr.rerun.scope": "blueprint" + "attr.rerun.scope": "blueprint", + "attr.docs.unreleased" ) { // --- Optional --- diff --git a/crates/store/re_types/definitions/rerun/blueprint/components/map_provider.fbs b/crates/store/re_types/definitions/rerun/blueprint/components/map_provider.fbs index 368a731797db..f9035f2f1444 100644 --- a/crates/store/re_types/definitions/rerun/blueprint/components/map_provider.fbs +++ b/crates/store/re_types/definitions/rerun/blueprint/components/map_provider.fbs @@ -3,7 +3,8 @@ namespace rerun.blueprint.components; /// Name of the map provider to be used in Map views. enum MapProvider: ubyte ( "attr.rerun.scope": "blueprint", - "attr.rust.derive": "Copy, PartialEq, Eq" + "attr.rust.derive": "Copy, PartialEq, Eq", + "attr.docs.unreleased" ) { /// Invalid value. Won't show up in generated types. Invalid = 0, diff --git a/crates/store/re_types/definitions/rerun/blueprint/components/zoom_level.fbs b/crates/store/re_types/definitions/rerun/blueprint/components/zoom_level.fbs index ef689d21b49a..08ccbc9e5a1e 100644 --- a/crates/store/re_types/definitions/rerun/blueprint/components/zoom_level.fbs +++ b/crates/store/re_types/definitions/rerun/blueprint/components/zoom_level.fbs @@ -6,7 +6,8 @@ table ZoomLevel ( "attr.python.aliases": "float", "attr.python.array_aliases": "npt.ArrayLike", "attr.rerun.scope": "blueprint", - "attr.rust.derive": "Default" + "attr.rust.derive": "Default", + "attr.docs.unreleased" ) { /// Zoom level: 0 being the lowest zoom level (fully zoomed out) and 22 being the highest (fully zoomed in). zoom: rerun.datatypes.Float32 (order: 100); diff --git a/crates/store/re_types/definitions/rerun/blueprint/views/map.fbs b/crates/store/re_types/definitions/rerun/blueprint/views/map.fbs index 797e9849ac9e..ade6d13b0ad7 100644 --- a/crates/store/re_types/definitions/rerun/blueprint/views/map.fbs +++ b/crates/store/re_types/definitions/rerun/blueprint/views/map.fbs @@ -5,7 +5,8 @@ namespace rerun.blueprint.views; /// \example views/map title="Use a blueprint to create a map view." //TODO(ab): add a screenshot table MapView ( - "attr.rerun.view_identifier": "Map" + "attr.rerun.view_identifier": "Map", + "attr.docs.unreleased" ) { /// Configures the zoom level of the map view. zoom: rerun.blueprint.archetypes.MapZoom (order: 1000); diff --git a/crates/store/re_types/definitions/rerun/components/latlon.fbs b/crates/store/re_types/definitions/rerun/components/latlon.fbs index 3633e8a1ea72..0508ad9140df 100644 --- a/crates/store/re_types/definitions/rerun/components/latlon.fbs +++ b/crates/store/re_types/definitions/rerun/components/latlon.fbs @@ -8,7 +8,8 @@ struct LatLon ( "attr.python.aliases": "npt.NDArray[np.float32], Sequence[float], Tuple[float, float]", "attr.python.array_aliases": "npt.NDArray[np.float32], Sequence[float]", "attr.rust.derive": "Default, Copy, PartialEq, bytemuck::Pod, bytemuck::Zeroable", - "attr.rust.repr": "transparent" + "attr.rust.repr": "transparent", + "attr.docs.unreleased" ) { lat_lon: rerun.datatypes.DVec2D (order: 100); } diff --git a/crates/store/re_types/definitions/rerun/datatypes/dvec2d.fbs b/crates/store/re_types/definitions/rerun/datatypes/dvec2d.fbs index fb46caefd757..e05450320dd6 100644 --- a/crates/store/re_types/definitions/rerun/datatypes/dvec2d.fbs +++ b/crates/store/re_types/definitions/rerun/datatypes/dvec2d.fbs @@ -9,7 +9,8 @@ struct DVec2D ( "attr.python.array_aliases": "npt.NDArray[Any], npt.ArrayLike, Sequence[Sequence[float]], Sequence[float]", "attr.rust.derive": "Default, Copy, PartialEq, bytemuck::Pod, bytemuck::Zeroable", "attr.rust.tuple_struct", - "attr.rust.repr": "C" + "attr.rust.repr": "C", + "attr.docs.unreleased" ) { xy: [double: 2] (order: 100); } diff --git a/docs/content/reference/types/archetypes/geo_points.md b/docs/content/reference/types/archetypes/geo_points.md index 698e7d7dee57..c0816b3199cd 100644 --- a/docs/content/reference/types/archetypes/geo_points.md +++ b/docs/content/reference/types/archetypes/geo_points.md @@ -18,7 +18,7 @@ Geospatial points with positions expressed in EPSG:4326 altitude and longitude, * [DataframeView](../views/dataframe_view.md) ## API reference links - * 🌊 [C++ API docs for `GeoPoints`](https://ref.rerun.io/docs/cpp/stable/structrerun_1_1archetypes_1_1GeoPoints.html) - * 🐍 [Python API docs for `GeoPoints`](https://ref.rerun.io/docs/python/stable/common/archetypes#rerun.archetypes.GeoPoints) - * 🦀 [Rust API docs for `GeoPoints`](https://docs.rs/rerun/latest/rerun/archetypes/struct.GeoPoints.html) + * 🌊 [C++ API docs for `GeoPoints`](https://ref.rerun.io/docs/cpp/stable/structrerun_1_1archetypes_1_1GeoPoints.html?speculative-link) + * 🐍 [Python API docs for `GeoPoints`](https://ref.rerun.io/docs/python/stable/common/archetypes?speculative-link#rerun.archetypes.GeoPoints) + * 🦀 [Rust API docs for `GeoPoints`](https://docs.rs/rerun/latest/rerun/archetypes/struct.GeoPoints.html?speculative-link) diff --git a/docs/content/reference/types/components/color.md b/docs/content/reference/types/components/color.md index c92678b527e5..7fc08869822d 100644 --- a/docs/content/reference/types/components/color.md +++ b/docs/content/reference/types/components/color.md @@ -26,7 +26,7 @@ byte is `R` and the least significant byte is `A`. * [`Boxes2D`](../archetypes/boxes2d.md) * [`Boxes3D`](../archetypes/boxes3d.md) * [`Ellipsoids3D`](../archetypes/ellipsoids3d.md) -* [`GeoPoints`](../archetypes/geo_points.md) +* [`GeoPoints`](../archetypes/geo_points.md?speculative-link) * [`LineStrips2D`](../archetypes/line_strips2d.md) * [`LineStrips3D`](../archetypes/line_strips3d.md) * [`Mesh3D`](../archetypes/mesh3d.md) diff --git a/docs/content/reference/types/components/lat_lon.md b/docs/content/reference/types/components/lat_lon.md index 4e1fc1f35fd3..5dfd2835a7da 100644 --- a/docs/content/reference/types/components/lat_lon.md +++ b/docs/content/reference/types/components/lat_lon.md @@ -10,11 +10,11 @@ A geographical position expressed in EPSG:4326 latitude and longitude. * lat_lon: [`DVec2D`](../datatypes/dvec2d.md) ## API reference links - * 🌊 [C++ API docs for `LatLon`](https://ref.rerun.io/docs/cpp/stable/structrerun_1_1components_1_1LatLon.html) - * 🐍 [Python API docs for `LatLon`](https://ref.rerun.io/docs/python/stable/common/components#rerun.components.LatLon) - * 🦀 [Rust API docs for `LatLon`](https://docs.rs/rerun/latest/rerun/components/struct.LatLon.html) + * 🌊 [C++ API docs for `LatLon`](https://ref.rerun.io/docs/cpp/stable/structrerun_1_1components_1_1LatLon.html?speculative-link) + * 🐍 [Python API docs for `LatLon`](https://ref.rerun.io/docs/python/stable/common/components?speculative-link#rerun.components.LatLon) + * 🦀 [Rust API docs for `LatLon`](https://docs.rs/rerun/latest/rerun/components/struct.LatLon.html?speculative-link) ## Used by -* [`GeoPoints`](../archetypes/geo_points.md) +* [`GeoPoints`](../archetypes/geo_points.md?speculative-link) diff --git a/docs/content/reference/types/components/radius.md b/docs/content/reference/types/components/radius.md index a2e3c6204837..b3d4c91f59f5 100644 --- a/docs/content/reference/types/components/radius.md +++ b/docs/content/reference/types/components/radius.md @@ -29,7 +29,7 @@ The Viewer's UI scaling defaults to the OS scaling which typically is 100% for f * [`Boxes2D`](../archetypes/boxes2d.md) * [`Boxes3D`](../archetypes/boxes3d.md) * [`Ellipsoids3D`](../archetypes/ellipsoids3d.md) -* [`GeoPoints`](../archetypes/geo_points.md) +* [`GeoPoints`](../archetypes/geo_points.md?speculative-link) * [`LineStrips2D`](../archetypes/line_strips2d.md) * [`LineStrips3D`](../archetypes/line_strips3d.md) * [`Points2D`](../archetypes/points2d.md) diff --git a/docs/content/reference/types/datatypes/dvec2d.md b/docs/content/reference/types/datatypes/dvec2d.md index 8c6a06cb4702..f39668b29bdf 100644 --- a/docs/content/reference/types/datatypes/dvec2d.md +++ b/docs/content/reference/types/datatypes/dvec2d.md @@ -10,11 +10,11 @@ A double-precision vector in 2D space. * xy: 2x `f64` ## API reference links - * 🌊 [C++ API docs for `DVec2D`](https://ref.rerun.io/docs/cpp/stable/structrerun_1_1datatypes_1_1DVec2D.html) - * 🐍 [Python API docs for `DVec2D`](https://ref.rerun.io/docs/python/stable/common/datatypes#rerun.datatypes.DVec2D) - * 🦀 [Rust API docs for `DVec2D`](https://docs.rs/rerun/latest/rerun/datatypes/struct.DVec2D.html) + * 🌊 [C++ API docs for `DVec2D`](https://ref.rerun.io/docs/cpp/stable/structrerun_1_1datatypes_1_1DVec2D.html?speculative-link) + * 🐍 [Python API docs for `DVec2D`](https://ref.rerun.io/docs/python/stable/common/datatypes?speculative-link#rerun.datatypes.DVec2D) + * 🦀 [Rust API docs for `DVec2D`](https://docs.rs/rerun/latest/rerun/datatypes/struct.DVec2D.html?speculative-link) ## Used by -* [`LatLon`](../components/lat_lon.md) +* [`LatLon`](../components/lat_lon.md?speculative-link) diff --git a/docs/content/reference/types/views/map_view.md b/docs/content/reference/types/views/map_view.md index 0be0ed707d83..730d94cbd175 100644 --- a/docs/content/reference/types/views/map_view.md +++ b/docs/content/reference/types/views/map_view.md @@ -13,7 +13,7 @@ Configures the zoom level of the map view. Configuration for the background map of the map view. ## API reference links - * 🐍 [Python API docs for `MapView`](https://ref.rerun.io/docs/python/stable/common/blueprint_views#rerun.blueprint.views.MapView) + * 🐍 [Python API docs for `MapView`](https://ref.rerun.io/docs/python/stable/common/blueprint_views?speculative-link#rerun.blueprint.views.MapView) ## Example