Update readmes from ros2 upstream #346
Conversation
* Add battery description * Absolute url * Use ros2-devel branch * Add panther_lights to url * Use ros2 branch
Merge panther_lights tables
WalkthroughThe changes primarily involve updating the Changes
Sequence Diagram(s)No complex control flow changes have been made that necessitate sequence diagrams. Modifications were primarily documentation and field updates. Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
Outside diff range and nitpick comments (3)
panther_lights/README.md (3)
Line range hint
124-124: Correct verb form for grammatical accuracy.- It have to match one of the channels defined in the `panels` section. + It has to match one of the channels defined in the `panels` section.Tools
Markdownlint
155-155: null (MD045, no-alt-text)
Images should have alternate text (alt text)
156-156: null (MD045, no-alt-text)
Images should have alternate text (alt text)
157-157: null (MD045, no-alt-text)
Images should have alternate text (alt text)
158-158: null (MD045, no-alt-text)
Images should have alternate text (alt text)
159-159: null (MD045, no-alt-text)
Images should have alternate text (alt text)
160-160: null (MD045, no-alt-text)
Images should have alternate text (alt text)
161-161: null (MD045, no-alt-text)
Images should have alternate text (alt text)
162-162: null (MD045, no-alt-text)
Images should have alternate text (alt text)
163-163: null (MD045, no-alt-text)
Images should have alternate text (alt text)
Line range hint
137-137: Add an article for grammatical correctness.- The `led_animations` section contains list with definitions for various animations... + The `led_animations` section contains a list with definitions for various animations...Tools
Markdownlint
155-155: null (MD045, no-alt-text)
Images should have alternate text (alt text)
156-156: null (MD045, no-alt-text)
Images should have alternate text (alt text)
157-157: null (MD045, no-alt-text)
Images should have alternate text (alt text)
158-158: null (MD045, no-alt-text)
Images should have alternate text (alt text)
159-159: null (MD045, no-alt-text)
Images should have alternate text (alt text)
160-160: null (MD045, no-alt-text)
Images should have alternate text (alt text)
161-161: null (MD045, no-alt-text)
Images should have alternate text (alt text)
162-162: null (MD045, no-alt-text)
Images should have alternate text (alt text)
163-163: null (MD045, no-alt-text)
Images should have alternate text (alt text)
Line range hint
144-144: Add a comma for clarity.- If not provided will default to **ANIMATION_<ID>**, where `<ID>` is equal to `id` parameter of the given animation. + If not provided, will default to **ANIMATION_<ID>**, where `<ID>` is equal to `id` parameter of the given animation.Tools
Markdownlint
155-155: null (MD045, no-alt-text)
Images should have alternate text (alt text)
156-156: null (MD045, no-alt-text)
Images should have alternate text (alt text)
157-157: null (MD045, no-alt-text)
Images should have alternate text (alt text)
158-158: null (MD045, no-alt-text)
Images should have alternate text (alt text)
159-159: null (MD045, no-alt-text)
Images should have alternate text (alt text)
160-160: null (MD045, no-alt-text)
Images should have alternate text (alt text)
161-161: null (MD045, no-alt-text)
Images should have alternate text (alt text)
162-162: null (MD045, no-alt-text)
Images should have alternate text (alt text)
163-163: null (MD045, no-alt-text)
Images should have alternate text (alt text)
Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Files selected for processing (1)
- panther_lights/README.md (1 hunks)
Additional context used
LanguageTool
panther_lights/README.md
[uncategorized] ~102-~102: If this is a compound adjective that modifies the following noun, use a hyphen. (EN_COMPOUND_ADJECTIVE_INTERNAL)
Context: ...o a YAML file with a description of the user defined animations. [//]: # (ROS_API_NODE_PARA...
[uncategorized] ~117-~117: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...ween multiple panels. -number_of_leds: defines the total number of LEDs presen...
[uncategorized] ~123-~123: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ... segment has three attributes: -name: the identifier for the segment, such as...
[uncategorized] ~124-~124: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...e between multiple segments. -channel: This specifies which LED panel the segm...
[grammar] ~124-~124: After ‘It’, use the third-person verb form “has”. (IT_VBZ)
Context: ...ch LED panel the segment belongs to. It have to match one of the channels defined in...
[uncategorized] ~125-~125: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...d in thepanelssection. -led_range: This defines the range of LEDs within t...
[uncategorized] ~129-~129: Did you mean: “By default,”? (BY_DEFAULT_COMMA)
Context: ...ents defined in thesegmentssection. By default you can use provided mapping: -all...
[uncategorized] ~137-~137: Possible missing article found. (AI_HYDRA_LEO_MISSING_A)
Context: ... Theled_animationssection contains list with definitions for various animations...
[uncategorized] ~144-~144: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...N_**]: name of an animation. If not provided will default to ANIMATION_, whe...
Markdownlint
panther_lights/README.md
146-146: Expected: 2; Actual: 4 (MD007, ul-indent)
Unordered list indentation
147-147: Expected: 2; Actual: 4 (MD007, ul-indent)
Unordered list indentation
148-148: Expected: 2; Actual: 4 (MD007, ul-indent)
Unordered list indentation
273-273: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
256-256: null (MD028, no-blanks-blockquote)
Blank line inside blockquote
155-155: null (MD045, no-alt-text)
Images should have alternate text (alt text)
156-156: null (MD045, no-alt-text)
Images should have alternate text (alt text)
157-157: null (MD045, no-alt-text)
Images should have alternate text (alt text)
158-158: null (MD045, no-alt-text)
Images should have alternate text (alt text)
159-159: null (MD045, no-alt-text)
Images should have alternate text (alt text)
160-160: null (MD045, no-alt-text)
Images should have alternate text (alt text)
161-161: null (MD045, no-alt-text)
Images should have alternate text (alt text)
162-162: null (MD045, no-alt-text)
Images should have alternate text (alt text)
163-163: null (MD045, no-alt-text)
Images should have alternate text (alt text)
| | ID | NAME | PRIORITY | ANIMATION | | ||
| | :---: | ----------------- | :------: | --------------------------------------------------------------------------------------------------------------------- | | ||
| | 0 | E_STOP | 3 | <img src="https://github.com/husarion/panther_ros/blob/ros2/panther_lights/.docs/E_STOP.webp" width="400"> | | ||
| | 1 | READY | 3 | <img src="https://github.com/husarion/panther_ros/blob/ros2/panther_lights/.docs/READY.webp" width="400"> | | ||
| | 2 | ERROR | 1 | <img src="https://github.com/husarion/panther_ros/blob/ros2/panther_lights/.docs/ERROR.webp" width="400"> | | ||
| | 3 | MANUAL_ACTION | 3 | <img src="https://github.com/husarion/panther_ros/blob/ros2/panther_lights/.docs/MANUAL_ACTION.webp" width="400"> | | ||
| | 4 | AUTONOMOUS_ACTION | 3 | <img src="https://github.com/husarion/panther_ros/blob/ros2/panther_lights/.docs/AUTONOMOUS_ACTION.webp" width="400"> | | ||
| | 5 | GOAL_ACHIEVED | 2 | <img src="https://github.com/husarion/panther_ros/blob/ros2/panther_lights/.docs/GOAL_ACHIEVED.webp" width="400"> | | ||
| | 6 | LOW_BATTERY | 2 | <img src="https://github.com/husarion/panther_ros/blob/ros2/panther_lights/.docs/LOW_BATTERY.webp" width="400"> | | ||
| | 7 | CRITICAL_BATTERY | 2 | <img src="https://github.com/husarion/panther_ros/blob/ros2/panther_lights/.docs/CRITICAL_BATTERY.webp" width="400"> | | ||
| | 9 | CHARGING_BATTERY | 3 | <img src="https://github.com/husarion/panther_ros/blob/ros2/panther_lights/.docs/CHARGING_BATTERY.webp" width="400"> | |
There was a problem hiding this comment.
Add alt text to images for accessibility.
- <img src="https://github.com/husarion/panther_ros/blob/ros2/panther_lights/.docs/E_STOP.webp" width="400">
+ <img src="https://github.com/husarion/panther_ros/blob/ros2/panther_lights/.docs/E_STOP.webp" alt="E_STOP Animation" width="400">Please apply similar changes to all image links in the table.
Committable suggestion was skipped due to low confidence.
Tools
Markdownlint
155-155: null (MD045, no-alt-text)
Images should have alternate text (alt text)
156-156: null (MD045, no-alt-text)
Images should have alternate text (alt text)
157-157: null (MD045, no-alt-text)
Images should have alternate text (alt text)
158-158: null (MD045, no-alt-text)
Images should have alternate text (alt text)
159-159: null (MD045, no-alt-text)
Images should have alternate text (alt text)
160-160: null (MD045, no-alt-text)
Images should have alternate text (alt text)
161-161: null (MD045, no-alt-text)
Images should have alternate text (alt text)
162-162: null (MD045, no-alt-text)
Images should have alternate text (alt text)
163-163: null (MD045, no-alt-text)
Images should have alternate text (alt text)
Description
The changes of readmes was added directly to the
ros2branch.Just backporting this to the
ros2-develSummary by CodeRabbit
led_animationssection in the README with image URLs for visual representations of animations, replacing textual descriptions.