Add missing documentation for PointsAnnotation outline_color and `t…

…hickness` fields (#58) **Public-Facing Changes** Added missing documentation for PointsAnnotation `outline_color` and `thickness` fields **Description** Foxglove Studio depended on the values of these fields, but they were not documented. Relates to https://github.com/foxglove/studio/issues/4080
foxglove · Aug 10, 2022 · e31bdfd · e31bdfd
1 parent e309363
commit e31bdfd
Show file tree

Hide file tree

Showing 10 changed files with 139 additions and 12 deletions.
diff --git a/ros_foxglove_msgs/ros1/PointsAnnotation.msg b/ros_foxglove_msgs/ros1/PointsAnnotation.msg
diff --git a/ros_foxglove_msgs/ros2/PointsAnnotation.msg b/ros_foxglove_msgs/ros2/PointsAnnotation.msg
diff --git a/schemas/README.md b/schemas/README.md
diff --git a/schemas/jsonschema/ImageAnnotations.json b/schemas/jsonschema/ImageAnnotations.json
diff --git a/schemas/jsonschema/PointsAnnotation.json b/schemas/jsonschema/PointsAnnotation.json
diff --git a/schemas/proto/foxglove/PointsAnnotation.proto b/schemas/proto/foxglove/PointsAnnotation.proto
diff --git a/schemas/ros1/PointsAnnotation.msg b/schemas/ros1/PointsAnnotation.msg
diff --git a/schemas/ros2/PointsAnnotation.msg b/schemas/ros2/PointsAnnotation.msg
diff --git a/schemas/typescript/PointsAnnotation.ts b/schemas/typescript/PointsAnnotation.ts
diff --git a/src/schemas.ts b/src/schemas.ts
@@ -575,17  575,28 @@ const foxglove_PointsAnnotation: FoxgloveMessageSchema = {
       description: "Points in 2D image coordinates",
       array: true,
     },
     {
       name: "outline_color",
       type: { type: "nested", schema: foxglove_Color },
       description: "Outline color",
     },
     {
       name: "outline_colors",
       type: { type: "nested", schema: foxglove_Color },
-      description: "Outline colors",
       description:
         "Per-point colors, if `type` is `POINTS`, or per-segment stroke colors, if `type` is `LINE_LIST`.",
       array: true,
     },
     {
       name: "fill_color",
       type: { type: "nested", schema: foxglove_Color },
       description: "Fill color",
     },
     {
       name: "thickness",
       type: { type: "primitive", name: "float64" },
       description: "Stroke thickness",
     },
   ],
 };