Skip to content

Commit ecabc17

Browse files
aneuwaldjtbandes
andauthored
Improve deprecated description (#23)
### Changelog Improve `deprecated` description ### Docs ### Description Improve `deprecated` description --------- Co-authored-by: Jacob Bandes-Storch <[email protected]>
1 parent b05a8aa commit ecabc17

File tree

1 file changed

+3
-13
lines changed

1 file changed

+3
-13
lines changed

src/types.ts

Lines changed: 3 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -183,20 +183,10 @@ export type MessageDefinitionField = {
183183
defaultValue?: DefaultValue;
184184

185185
/**
186-
* Set to true if this field is marked as deprecated in the message definition.
186+
* Indicates whether this field is marked as deprecated.
187187
*
188-
* Some interface definition languages explicitly support deprecation metadata,
189-
* while others do not. For example:
190-
*
191-
* - In **Protobuf**, fields can be declared as deprecated using the `[deprecated = true]`
192-
* annotation in the `.proto` schema, which is reflected in the field descriptor.
193-
* - In **FlatBuffers**, deprecation information is available through the
194-
* reflection schema (via the `deprecated` boolean flag on a `Field` object).
195-
* - Other formats (e.g., some JSON-based schemas or older ROS message formats)
196-
* might not expose deprecation data at all.
197-
*
198-
* This flag can be used by tools or UIs to visually indicate deprecated fields
199-
* (e.g., graying them out) or to exclude them from subscriptions and validation.
188+
* Some IDLs (e.g., Protobuf, FlatBuffers, JSON Schema) explicitly support deprecation metadata,
189+
* while others (such as ROS .msg or PX4 ULog) do not.
200190
*/
201191
deprecated?: boolean;
202192
};

0 commit comments

Comments
 (0)