Skip to content

Commit 01fe23d

Browse files
authored
Component docs: link to the rerun datatype the component wraps (#7996)
### What * Follow-up to #7986 ### 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/7996?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/7996?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)! * [x] If have noted any breaking changes to the log API in `CHANGELOG.md` and the migration guide - [PR Build Summary](https://build.rerun.io/pr/7996) - [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`.
1 parent fb5a4c6 commit 01fe23d

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

58 files changed

+179
-5
lines changed

crates/build/re_types_builder/src/codegen/docs/mod.rs

+10-2
Original file line numberDiff line numberDiff line change
@@ -476,8 +476,16 @@ fn write_fields(objects: &Objects, o: &mut String, object: &Object) {
476476
}
477477

478478
if object.is_arrow_transparent() {
479-
debug_assert!(object.is_struct());
480-
debug_assert_eq!(object.fields.len(), 1);
479+
assert!(object.is_struct());
480+
assert_eq!(object.fields.len(), 1);
481+
let field_type = &object.fields[0].typ;
482+
if object.kind == ObjectKind::Component && matches!(field_type, Type::Object(_)) {
483+
putln!(o, "## Rerun datatype");
484+
putln!(o, "{}", type_info(objects, field_type));
485+
putln!(o);
486+
} else {
487+
// The arrow datatype section covers it
488+
}
481489
return; // This is just a wrapper type, so don't show the "Fields" section
482490
}
483491

docs/content/reference/types/components/albedo_factor.md

+3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/content/reference/types/components/axis_length.md

+3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/content/reference/types/components/blob.md

+3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/content/reference/types/components/class_id.md

+3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/content/reference/types/components/clear_is_recursive.md

+3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/content/reference/types/components/color.md

+3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/content/reference/types/components/depth_meter.md

+3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/content/reference/types/components/disconnected_space.md

+3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/content/reference/types/components/draw_order.md

+3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/content/reference/types/components/entity_path.md

+3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/content/reference/types/components/fill_ratio.md

+3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/content/reference/types/components/gamma_correction.md

+3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/content/reference/types/components/half_size2d.md

+3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/content/reference/types/components/half_size3d.md

+3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/content/reference/types/components/image_buffer.md

+3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/content/reference/types/components/image_format.md

+3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/content/reference/types/components/image_plane_distance.md

+3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/content/reference/types/components/keypoint_id.md

+3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/content/reference/types/components/lat_lon.md

+3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/content/reference/types/components/length.md

+3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/content/reference/types/components/marker_size.md

+3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/content/reference/types/components/media_type.md

+3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/content/reference/types/components/name.md

+3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/content/reference/types/components/opacity.md

+3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/content/reference/types/components/pinhole_projection.md

+3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/content/reference/types/components/pose_rotation_axis_angle.md

+3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/content/reference/types/components/pose_rotation_quat.md

+3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/content/reference/types/components/pose_scale3d.md

+3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/content/reference/types/components/pose_transform_mat3x3.md

+3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/content/reference/types/components/pose_translation3d.md

+3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/content/reference/types/components/position2d.md

+3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/content/reference/types/components/position3d.md

+3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/content/reference/types/components/radius.md

+3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/content/reference/types/components/range1d.md

+3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/content/reference/types/components/resolution.md

+3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/content/reference/types/components/rotation_axis_angle.md

+3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/content/reference/types/components/rotation_quat.md

+3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/content/reference/types/components/scalar.md

+3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)