Skip to content

Commit ebe5302

Browse files
authored
Fix typo in ros1 profile spec (#680)
**Public-Facing Changes** Fixed a typo in the appendix. All implementations have been using message_encoding `ros1` to match the `ros1` schema encoding and profile. **Description** Closes #679
1 parent 2c7cf24 commit ebe5302

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

docs/specification/appendix.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -121,33 +121,33 @@ The `ros1` profile describes how to create MCAP files for [ROS 1](https://wiki.r
121121

122122
#### Header
123123

124-
- `profile`: MUST contain `ros1`
124+
- `profile`: MUST be `ros1`
125125

126126
#### Channel
127127

128-
- `message_encoding`: MUST contain `ros`
128+
- `message_encoding`: MUST be `ros1`
129129
- `metadata` keys:
130130
- `callerid` (optional, string)
131131
- `latching` (optional, bool stringified as "true" or "false")
132132

133133
#### Schema
134134

135-
- `encoding`: MUST contain `ros1msg`
135+
- `encoding`: MUST be `ros1msg`
136136

137137
### ROS2
138138

139139
The `ros2` profile describes how to create MCAP files for [ROS 2](https://docs.ros.org/).
140140

141141
#### Header
142142

143-
- `profile`: MUST contain `ros2`
143+
- `profile`: MUST be `ros2`
144144

145145
#### Channel
146146

147-
- `message_encoding`: MUST contain `cdr`
147+
- `message_encoding`: MUST be `cdr`
148148
- `metadata`:
149149
- `offered_qos_profiles` (required, string)
150150

151151
#### Schema
152152

153-
- `encoding`: MUST contain either `ros2msg` or `ros2idl`
153+
- `encoding`: MUST be either `ros2msg` or `ros2idl`

0 commit comments

Comments
 (0)