Skip to content

Commit

Permalink
Documentation for archetype and views references each other (#6319)
Browse files Browse the repository at this point in the history
### What

* Fixes: #6082
* Based on: #6304 
---

* Archetype link now to view that they show up in
* Views now link to archetypes that they support
* View page now lists properties with argument name and argument
documentation instead of type docs
* I also tried linking to the type's reference page but it got too much!
* changed name of 'link' section


Note to reviewer: Mind `Large diffs are not rendered by default.`!

<img width="1379" alt="image"
src="https://github.com/rerun-io/rerun/assets/1220815/c32a6329-7f9f-4a2e-8982-108a0d8e028c">
<img width="741" alt="image"
src="https://github.com/rerun-io/rerun/assets/1220815/ebe14bb7-e0bd-486a-b501-4b10c7dd0d0f">


### Checklist
* [x] I have read and agree to [Contributor
Guide](https://github.com/rerun-io/rerun/blob/main/CONTRIBUTING.md) and
the [Code of
Conduct](https://github.com/rerun-io/rerun/blob/main/CODE_OF_CONDUCT.md)
* [x] I've included a screenshot or gif (if applicable)
* [x] I have tested the web demo (if applicable):
* Using examples from latest `main` build:
[rerun.io/viewer](https://rerun.io/viewer/pr/6319?manifest_url=https://app.rerun.io/version/main/examples_manifest.json)
* Using full set of examples from `nightly` build:
[rerun.io/viewer](https://rerun.io/viewer/pr/6319?manifest_url=https://app.rerun.io/version/nightly/examples_manifest.json)
* [x] The PR title and labels are set such as to maximize their
usefulness for the next release's CHANGELOG
* [x] If applicable, add a new check to the [release
checklist](https://github.com/rerun-io/rerun/blob/main/tests/python/release_checklist)!

- [PR Build Summary](https://build.rerun.io/pr/6319)
- [Recent benchmark results](https://build.rerun.io/graphs/crates.html)
- [Wasm size tracking](https://build.rerun.io/graphs/sizes.html)

To run all checks from `main`, comment on the PR with `@rerun-bot
full-check`.
  • Loading branch information
Wumpf authored May 14, 2024
1 parent 6dd77cc commit 74998a4
Show file tree
Hide file tree
Showing 172 changed files with 790 additions and 358 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/reusable_checks.yml
Original file line number Diff line number Diff line change
Expand Up @@ -203,4 +203,4 @@ jobs:
# When given a directory, lychee checks only markdown, html and text files, everything else we have to glob in manually.
# Pass --verbose, so that all considered links are printed, making it easier to debug.
args: |
--verbose --base . "**/*.rs" "**/*.toml" "**/*.hpp" "**/*.cpp" "**/CMakeLists.txt" "**/*.py" "**/*.yml"
--verbose --base . "**/*.md" "**/*.rs" "**/*.toml" "**/*.hpp" "**/*.cpp" "**/CMakeLists.txt" "**/*.py" "**/*.yml"
10 changes: 10 additions & 0 deletions crates/re_types/definitions/docs/attributes.fbs
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,13 @@ attribute "attr.docs.unreleased";

/// Apply to an archetype to set its category used in the docs.
attribute "attr.docs.category";

/// Apply to an archetype to document which viewer support showing it.
///
/// This is expected to be a comma separated list of viewer types names.
/// If additional information about the circumstances under which a viewer supports the archetype is needed,
/// add it after a colon.
///
/// E.g.:
/// "attr.docs.view_types": "Spatial2DView, Spatial3DView: if logged under a projection"
attribute "attr.docs.view_types";
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,8 @@ namespace rerun.archetypes;
/// \example archetypes/annotation_context_segmentation title="Segmentation" image="https://static.rerun.io/annotation_context_segmentation/0e21c0a04e456fec41d16b0deaa12c00cddf2d9b/1200w.png"
/// \example archetypes/annotation_context_connections !api title="Connections" image="https://static.rerun.io/annotation_context_connections/4a8422bc154699c5334f574ff01b55c5cd1748e3/1200w.png"
table AnnotationContext (
"attr.rust.derive": "Eq, PartialEq"
"attr.rust.derive": "Eq, PartialEq",
"attr.docs.view_types": "Spatial2DView, Spatial3DView"
) {
/// List of class descriptions, mapping class indices to class names, colors etc.
context: rerun.components.AnnotationContext ("attr.rerun.component_required", order: 1000);
Expand Down
3 changes: 2 additions & 1 deletion crates/re_types/definitions/rerun/archetypes/arrows2d.fbs
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,8 @@ table Arrows2D (
"attr.rust.derive": "PartialEq",
"attr.rust.new_pub_crate",
"attr.cpp.no_field_ctors",
"attr.docs.category": "Spatial 2D"
"attr.docs.category": "Spatial 2D",
"attr.docs.view_types": "Spatial2DView, Spatial3DView: if logged under a projection"
) {
// --- Required ---

Expand Down
3 changes: 2 additions & 1 deletion crates/re_types/definitions/rerun/archetypes/arrows3d.fbs
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,8 @@ table Arrows3D (
"attr.rust.derive": "PartialEq",
"attr.rust.new_pub_crate",
"attr.cpp.no_field_ctors",
"attr.docs.category": "Spatial 3D"
"attr.docs.category": "Spatial 3D",
"attr.docs.view_types": "Spatial3DView, Spatial2DView: if logged above active projection"
) {
// --- Required ---

Expand Down
3 changes: 2 additions & 1 deletion crates/re_types/definitions/rerun/archetypes/asset3d.fbs
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,8 @@ namespace rerun.archetypes;
/// \example archetypes/asset3d_out_of_tree !api title="3D asset with out-of-tree transform"
table Asset3D (
"attr.rust.derive": "PartialEq",
"attr.docs.category": "Spatial 3D"
"attr.docs.category": "Spatial 3D",
"attr.docs.view_types": "Spatial3DView, Spatial2DView: if logged above active projection"
) {
// --- Required ---

Expand Down
3 changes: 2 additions & 1 deletion crates/re_types/definitions/rerun/archetypes/bar_chart.fbs
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,8 @@ namespace rerun.archetypes;
/// \example archetypes/bar_chart title="Simple bar chart" image="https://static.rerun.io/barchart_simple/cf6014b18265edfcaa562c06526c0716b296b193/1200w.png"
table BarChart (
"attr.rust.derive": "PartialEq",
"attr.docs.category": "Plotting"
"attr.docs.category": "Plotting",
"attr.docs.view_types": "BarChartView"
) {
// --- Required ---

Expand Down
3 changes: 2 additions & 1 deletion crates/re_types/definitions/rerun/archetypes/boxes2d.fbs
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,8 @@ table Boxes2D (
"attr.rust.derive": "PartialEq",
"attr.rust.new_pub_crate",
"attr.cpp.no_field_ctors",
"attr.docs.category": "Spatial 2D"
"attr.docs.category": "Spatial 2D",
"attr.docs.view_types": "Spatial2DView, Spatial3DView: if logged under a projection"
) {
// --- Required ---

Expand Down
3 changes: 2 additions & 1 deletion crates/re_types/definitions/rerun/archetypes/boxes3d.fbs
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,8 @@ table Boxes3D (
"attr.rust.derive": "PartialEq",
"attr.rust.new_pub_crate",
"attr.cpp.no_field_ctors",
"attr.docs.category": "Spatial 3D"
"attr.docs.category": "Spatial 3D",
"attr.docs.view_types": "Spatial3DView, Spatial2DView: if logged above active projection"
) {
// --- Required ---

Expand Down
3 changes: 2 additions & 1 deletion crates/re_types/definitions/rerun/archetypes/clear.fbs
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,8 @@ namespace rerun.archetypes;
/// \example archetypes/clear_recursive !api "Recursive"
table Clear (
"attr.rust.derive": "PartialEq, Eq",
"attr.rust.override_crate": "re_types_core"
"attr.rust.override_crate": "re_types_core",
"attr.docs.view_types": "Spatial2DView, Spatial3DView, TimeSeriesView"
) {
is_recursive: rerun.components.ClearIsRecursive ("attr.rerun.component_required", order: 100);
}
3 changes: 2 additions & 1 deletion crates/re_types/definitions/rerun/archetypes/depth_image.fbs
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,8 @@ namespace rerun.archetypes;
table DepthImage (
"attr.rust.derive": "PartialEq",
"attr.cpp.no_field_ctors",
"attr.docs.category": "Image & tensor"
"attr.docs.category": "Image & tensor",
"attr.docs.view_types": "Spatial2DView, Spatial3DView: if logged under a projection"
) {
// --- Required ---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,8 @@ namespace rerun.archetypes;
///
/// \example archetypes/disconnected_space title="Disconnected space" image="https://static.rerun.io/disconnected_space/b8f95b0e32359de625a765247c84935146c1fba9/1200w.png"
table DisconnectedSpace (
"attr.rust.derive": "Copy, PartialEq, Eq"
"attr.rust.derive": "Copy, PartialEq, Eq",
"attr.docs.view_types": "Spatial2DView, Spatial3DView"
) {
/// Whether the entity path at which this is logged is disconnected from its parent.
disconnected_space: rerun.components.DisconnectedSpace ("attr.rerun.component_required", order: 1000);
Expand Down
3 changes: 2 additions & 1 deletion crates/re_types/definitions/rerun/archetypes/image.fbs
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,8 @@ namespace rerun.archetypes;
table Image (
"attr.rust.derive": "PartialEq",
"attr.cpp.no_field_ctors",
"attr.docs.category": "Image & tensor"
"attr.docs.category": "Image & tensor",
"attr.docs.view_types": "Spatial2DView, Spatial3DView: if logged under a projection"
) {
// --- Required ---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,8 @@ namespace rerun.archetypes;
/// \example archetypes/line_strip2d_batch image="https://static.rerun.io/line_strip2d_batch/d8aae7ca3d6c3b0e3b636de60b8067fa2f0b6db9/1200w.png"
table LineStrips2D (
"attr.rust.derive": "PartialEq",
"attr.docs.category": "Spatial 2D"
"attr.docs.category": "Spatial 2D",
"attr.docs.view_types": "Spatial2DView, Spatial3DView: if logged under a projection"
) {
// --- Required ---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,8 @@ namespace rerun.archetypes;
/// \example archetypes/line_strip3d_batch title="Many strips" image="https://static.rerun.io/line_strip3d_batch/102e5ec5271475657fbc76b469267e4ec8e84337/1200w.png"
table LineStrips3D (
"attr.rust.derive": "PartialEq",
"attr.docs.category": "Spatial 3D"
"attr.docs.category": "Spatial 3D",
"attr.docs.view_types": "Spatial3DView, Spatial2DView: if logged above active projection"
) {
// --- Required ---

Expand Down
3 changes: 2 additions & 1 deletion crates/re_types/definitions/rerun/archetypes/mesh3d.fbs
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,8 @@ namespace rerun.archetypes;
/// \example archetypes/mesh3d_partial_updates !api title="3D mesh with partial updates" image="https://static.rerun.io/mesh3d_partial_updates/a11e4accb0257dcd9531867b7e1d6fd5e3bee5c3/1200w.png"
table Mesh3D (
"attr.rust.derive": "PartialEq",
"attr.docs.category": "Spatial 2D"
"attr.docs.category": "Spatial 3D",
"attr.docs.view_types": "Spatial3DView, Spatial2DView: if logged above active projection"
) {
// --- Required ---

Expand Down
3 changes: 2 additions & 1 deletion crates/re_types/definitions/rerun/archetypes/pinhole.fbs
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,8 @@ namespace rerun.archetypes;
/// \example archetypes/pinhole_perspective title="Perspective pinhole camera" image="https://static.rerun.io/pinhole_perspective/d0bd02a0cf354a5c8eafb79a84fe8674335cab98/1200w.png"
table Pinhole (
"attr.rust.derive": "PartialEq",
"attr.docs.category": "Spatial 3D"
"attr.docs.category": "Spatial 3D",
"attr.docs.view_types": "Spatial2DView, Spatial2DView"
) {
// --- Required ---

Expand Down
3 changes: 2 additions & 1 deletion crates/re_types/definitions/rerun/archetypes/points2d.fbs
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,8 @@ namespace rerun.archetypes;
/// \example archetypes/point2d_random title="Randomly distributed 2D points with varying color and radius" image="https://static.rerun.io/point2d_random/8e8ac75373677bd72bd3f56a15e44fcab309a168/1200w.png"
table Points2D (
"attr.rust.derive": "PartialEq",
"attr.docs.category": "Spatial 2D"
"attr.docs.category": "Spatial 2D",
"attr.docs.view_types": "Spatial2DView, Spatial3DView: if logged under a projection"
) {
// --- Required ---

Expand Down
3 changes: 2 additions & 1 deletion crates/re_types/definitions/rerun/archetypes/points3d.fbs
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,8 @@ namespace rerun.archetypes;
/// \example archetypes/point3d_random title="Randomly distributed 3D points with varying color and radius" image="https://static.rerun.io/point3d_random/7e94e1806d2c381943748abbb3bedb68d564de24/1200w.png"
table Points3D (
"attr.rust.derive": "PartialEq",
"attr.docs.category": "Spatial 3D"
"attr.docs.category": "Spatial 3D",
"attr.docs.view_types": "Spatial3DView, Spatial2DView: if logged above active projection"
) {
// --- Required ---

Expand Down
3 changes: 2 additions & 1 deletion crates/re_types/definitions/rerun/archetypes/scalar.fbs
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,8 @@ namespace rerun.archetypes;
/// \example archetypes/scalar_multiple_plots !api title="Multiple time series plots" image="https://static.rerun.io/scalar_multiple/15845c2a348f875248fbd694e03eabd922741c4c/1200w.png"
table Scalar (
"attr.rust.derive": "PartialEq",
"attr.docs.category": "Plotting"
"attr.docs.category": "Plotting",
"attr.docs.view_types": "TimeSeriesView"
) {
// --- Required ---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,8 @@ namespace rerun.archetypes;
table SegmentationImage (
"attr.rust.derive": "PartialEq",
"attr.cpp.no_field_ctors",
"attr.docs.category": "Image & tensor"
"attr.docs.category": "Image & tensor",
"attr.docs.view_types": "Spatial2DView, Spatial3DView: if logged under a projection"
) {
// --- Required ---

Expand Down
3 changes: 2 additions & 1 deletion crates/re_types/definitions/rerun/archetypes/series_line.fbs
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,8 @@ namespace rerun.archetypes;
///
/// \example archetypes/series_line_style title="Line series" image="https://static.rerun.io/series_line_style/d2616d98b1e46bdb85849b8669154fdf058e3453/1200w.png"
table SeriesLine (
"attr.docs.category": "Plotting"
"attr.docs.category": "Plotting",
"attr.docs.view_types": "TimeSeriesView"
) {
// --- Required ---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,8 @@ namespace rerun.archetypes;
///
/// \example archetypes/series_point_style title="Point series" image="https://static.rerun.io/series_point_style/82207a705da6c086b28ce161db1db9e8b12258b7/1200w.png"
table SeriesPoint (
"attr.docs.category": "Plotting"
"attr.docs.category": "Plotting",
"attr.docs.view_types": "TimeSeriesView"
) {
// --- Required ---

Expand Down
3 changes: 2 additions & 1 deletion crates/re_types/definitions/rerun/archetypes/tensor.fbs
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,8 @@ namespace rerun.archetypes;
/// \example archetypes/tensor_simple title="Simple tensor" image="https://static.rerun.io/tensor_simple/baacb07712f7b706e3c80e696f70616c6c20b367/1200w.png"
table Tensor (
"attr.rust.derive": "PartialEq",
"attr.docs.category": "Image & tensor"
"attr.docs.category": "Image & tensor",
"attr.docs.view_types": "TensorView, BarChartView: for 1D tensors"
) {
/// The tensor data
data: rerun.components.TensorData ("attr.rerun.component_required", order: 1000);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,8 @@ namespace rerun.archetypes;
/// \example archetypes/text_document title="Markdown text document" image="https://static.rerun.io/textdocument/babda19558ee32ed8d730495b595aee7a5e2c174/1200w.png"
table TextDocument (
"attr.rust.derive": "PartialEq, Eq",
"attr.docs.category": "Text"
"attr.docs.category": "Text",
"attr.docs.view_types": "TextDocumentView"
) {
/// Contents of the text document.
text: rerun.components.Text ("attr.rerun.component_required", order: 100);
Expand Down
3 changes: 2 additions & 1 deletion crates/re_types/definitions/rerun/archetypes/text_log.fbs
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,8 @@ namespace rerun.archetypes;
/// \example archetypes/text_log_integration text="Logging text directly or via a logger" image="https://static.rerun.io/text_log_integration/9737d0c986325802a9885499d6fcc773b1736488/1200w.png"
table TextLog (
"attr.rust.derive": "PartialEq, Eq",
"attr.docs.category": "Text"
"attr.docs.category": "Text",
"attr.docs.view_types": "TextLogView"
) {
/// The body of the message.
text: rerun.components.Text ("attr.rerun.component_required", order: 100);
Expand Down
3 changes: 2 additions & 1 deletion crates/re_types/definitions/rerun/archetypes/transform3d.fbs
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,8 @@ namespace rerun.archetypes;
/// \example archetypes/transform3d_simple title="Variety of 3D transforms" image="https://static.rerun.io/transform3d_simple/141368b07360ce3fcb1553079258ae3f42bdb9ac/1200w.png"
table Transform3D (
"attr.rust.derive": "PartialEq",
"attr.docs.category": "Spatial 3D"
"attr.docs.category": "Spatial 3D",
"attr.docs.view_types": "Spatial3DView, Spatial2DView: if logged above active projection"
) {
/// The transform
transform: rerun.components.Transform3D ("attr.rerun.component_required", order: 1000);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,8 @@ namespace rerun.archetypes;
table ViewCoordinates (
"attr.rust.derive": "Copy, PartialEq, Eq, bytemuck::Pod, bytemuck::Zeroable",
"attr.rust.repr": "transparent",
"attr.docs.category": "Spatial 3D"
"attr.docs.category": "Spatial 3D",
"attr.docs.view_types": "Spatial3DView"
) {
/// The directions of the [x, y, z] axes.
xyz: rerun.components.ViewCoordinates ("attr.rerun.component_required", required, order: 1000);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ namespace rerun.blueprint.archetypes;

/// Configuration for the legend of a plot.
table PlotLegend (
"attr.docs.unreleased",
"attr.rerun.scope": "blueprint",
"attr.rust.derive": "Default",
"attr.python.aliases": "blueprint_components.Corner2D"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ namespace rerun.blueprint.archetypes;

/// Configuration for the scalar axis of a plot.
table ScalarAxis (
"attr.docs.unreleased",
"attr.rerun.scope": "blueprint",
"attr.rust.derive": "Default"
) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ namespace rerun.blueprint.archetypes;
/// - For time series views, the default is to show the entire timeline.
/// - For any other view, the default is to apply latest-at semantics.
table VisibleTimeRanges (
"attr.docs.unreleased",
"attr.rerun.scope": "blueprint",
"attr.rust.derive": "Default",
"attr.python.aliases": "datatypes.VisibleTimeRangeLike, Sequence[datatypes.VisibleTimeRangeLike]"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ namespace rerun.blueprint.archetypes;

/// Controls the visual bounds of a 2D space view.
table VisualBounds (
"attr.docs.unreleased",
"attr.rerun.scope": "blueprint",
"attr.rust.derive": "Copy"
) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ namespace rerun.blueprint.views;
///
/// \example views/bar_chart title="Use a blueprint to create a BarChartView." image="https://static.rerun.io/bar_chart_view/74fa45af3c7310b51cd283c37439ed8f8ca9356d/1200w.png"
table BarChartView (
"attr.docs.unreleased",
"attr.rerun.view_identifier": "BarChart"
) {
}
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,10 @@ namespace rerun.blueprint.views;
///
/// \example views/spatial2d title="Use a blueprint to customize a Spatial2DView." image="https://static.rerun.io/spatial2d/074c0822870325d6502c9f51c165c1181a20e83f/1200w.png"
table Spatial2DView (
"attr.docs.unreleased",
"attr.rerun.view_identifier": "2D"
) {
/// Configuration for the background of the space view.
/// Configuration for the background of the view.
background: rerun.blueprint.archetypes.Background (order: 1000);

/// The visible parts of the scene, in the coordinate space of the scene.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,10 @@ namespace rerun.blueprint.views;
///
/// \example views/spatial3d title="Use a blueprint to customize a Spatial3DView." image="https://static.rerun.io/spatial3d/4816694fc4176cc284ff30d9c8f06c936a625ac9/1200w.png"
table Spatial3DView (
"attr.docs.unreleased",
"attr.rerun.view_identifier": "3D"
) {
/// Configuration for the background of the space view.
/// Configuration for the background of the view.
background: rerun.blueprint.archetypes.Background (order: 1000);

/// Configures which range on each timeline is shown by this view (unless specified differently per entity).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ namespace rerun.blueprint.views;
///
/// \example views/tensor title="Use a blueprint to create a TensorView." image="https://static.rerun.io/tensor_view/3b452ace3cdb29ada1a613eae8e8e8e165a1d396/1200w.png"
table TensorView (
"attr.docs.unreleased",
"attr.rerun.view_identifier": "Tensor"
) {
}
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ namespace rerun.blueprint.views;
///
/// \example views/text_document title="Use a blueprint to show a text document." image="https://static.rerun.io/text_log/27f15235fe9639ff42b6ea0d2f0ce580685c021c/1200w.png"
table TextDocumentView (
"attr.docs.unreleased",
"attr.rerun.view_identifier": "TextDocument"
) {
}
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ namespace rerun.blueprint.views;
///
/// \example views/text_log title="Use a blueprint to show a TextLogView." image="https://static.rerun.io/text_log/457ab91ec42a481bacae4146c0fc01eee397bb86/1200w.png"
table TextLogView (
"attr.docs.unreleased",
"attr.rerun.view_identifier": "TextLog"
) {
}
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ namespace rerun.blueprint.views;
///
/// \example views/timeseries title="Use a blueprint to customize a TimeSeriesView." image="https://static.rerun.io/timeseries_view/c87150647feb413627fdb8563afe33b39d7dbf57/1200w.png"
table TimeSeriesView (
"attr.docs.unreleased",
"attr.rerun.view_identifier": "TimeSeries"
) {
/// Configures the vertical axis of the plot.
Expand Down
1 change: 1 addition & 0 deletions crates/re_types/definitions/rerun/components/range1d.fbs
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ namespace rerun.components;

/// A 1D range, specifying a lower and upper bound.
struct Range1D (
"attr.docs.unreleased",
"attr.rust.derive": "Copy, PartialEq, bytemuck::Pod, bytemuck::Zeroable",
"attr.rust.repr": "transparent"
) {
Expand Down
1 change: 1 addition & 0 deletions crates/re_types/definitions/rerun/components/range2d.fbs
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ namespace rerun.components;

/// An Axis-Aligned Bounding Box in 2D space.
struct Range2D (
"attr.docs.unreleased",
"attr.rust.derive": "Copy, PartialEq, bytemuck::Pod, bytemuck::Zeroable",
"attr.rust.repr": "transparent"
) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ namespace rerun.components;

/// The three indices of a triangle mesh.
struct TriangleIndices (
"attr.docs.unreleased",
"attr.rust.derive": "Copy, PartialEq, Eq, bytemuck::Pod, bytemuck::Zeroable",
"attr.rust.repr": "transparent"
) {
Expand Down
Loading

0 comments on commit 74998a4

Please sign in to comment.