Put type into the body of the field docs

rerun-io · Nov 4, 2024 · 7fe8240 · 7fe8240
1 parent 5a6dcaa
commit 7fe8240
Show file tree

Hide file tree

Showing 16 changed files with 139 additions and 47 deletions.
diff --git a/crates/build/re_types_builder/src/codegen/docs/mod.rs b/crates/build/re_types_builder/src/codegen/docs/mod.rs
@@ -488,9 +488,10 @@ fn write_fields(objects: &Objects, o: &mut String, object: &Object) {
         if let Some(enum_value) = field.enum_value {
             field_string.push_str(&format!(" = {enum_value}"));
         }
+        field_string.push('\n');
 
         if !object.is_enum() {
-            field_string.push_str(": ");
+            field_string.push_str("Type: ");
             if field.typ == Type::Unit {
                 field_string.push_str("`null`");
             } else {
@@ -499,9 +500,10 @@ fn write_fields(objects: &Objects, o: &mut String, object: &Object) {
                 }
                 field_string.push_str(&type_info(objects, &field.typ));
             }
+            field_string.push('\n');
+            field_string.push('\n');
         }
 
-        field_string.push('\n');
         for line in field.docs.lines_for(objects, Target::WebDocsMarkdown) {
             field_string.push_str(&line);
             field_string.push('\n');

diff --git a/docs/content/reference/types/datatypes/annotation_info.md b/docs/content/reference/types/datatypes/annotation_info.md
diff --git a/docs/content/reference/types/datatypes/class_description.md b/docs/content/reference/types/datatypes/class_description.md
diff --git a/docs/content/reference/types/datatypes/class_description_map_elem.md b/docs/content/reference/types/datatypes/class_description_map_elem.md
diff --git a/docs/content/reference/types/datatypes/image_format.md b/docs/content/reference/types/datatypes/image_format.md
diff --git a/docs/content/reference/types/datatypes/keypoint_pair.md b/docs/content/reference/types/datatypes/keypoint_pair.md
diff --git a/docs/content/reference/types/datatypes/range2d.md b/docs/content/reference/types/datatypes/range2d.md
diff --git a/docs/content/reference/types/datatypes/rotation_axis_angle.md b/docs/content/reference/types/datatypes/rotation_axis_angle.md
diff --git a/docs/content/reference/types/datatypes/tensor_buffer.md b/docs/content/reference/types/datatypes/tensor_buffer.md
diff --git a/docs/content/reference/types/datatypes/tensor_data.md b/docs/content/reference/types/datatypes/tensor_data.md
diff --git a/docs/content/reference/types/datatypes/tensor_dimension.md b/docs/content/reference/types/datatypes/tensor_dimension.md
diff --git a/docs/content/reference/types/datatypes/tensor_dimension_index_selection.md b/docs/content/reference/types/datatypes/tensor_dimension_index_selection.md
diff --git a/docs/content/reference/types/datatypes/tensor_dimension_selection.md b/docs/content/reference/types/datatypes/tensor_dimension_selection.md
diff --git a/docs/content/reference/types/datatypes/time_range.md b/docs/content/reference/types/datatypes/time_range.md
diff --git a/docs/content/reference/types/datatypes/time_range_boundary.md b/docs/content/reference/types/datatypes/time_range_boundary.md
diff --git a/docs/content/reference/types/datatypes/visible_time_range.md b/docs/content/reference/types/datatypes/visible_time_range.md