Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOCS-1099: Update note.md #1777

Merged
merged 4 commits into from
Sep 12, 2023
Merged

DOCS-1099: Update note.md #1777

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
01f0278
Include alert titles in note.md
skyleilani Sep 8, 2023
d60ace2
move new info
skyleilani Sep 8, 2023
f1353cd
Merge branch 'main' into Update-note-md
skyleilani Sep 10, 2023
5fe01ba
Merge branch 'main' into Update-note-md
skyleilani Sep 12, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/note.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -214,6 +214,8 @@ await arm.move_to_position(pose=pos, world_state=worldstate)
They both use the same color.

**Note/Important/Stability Notice**: These call attention to something important.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
**Note/Important/Stability Notice**: These call attention to something important.
**Important/Stability Notice**: These call attention to something important.

Out of diff but I realized this should be changed as well

When creating alerts about important messages, set the title attribute as `title="Important"`.
If you want to include a more detailed title or message, use `title="Important: $message"` to provide additional context.

**Caution**: Provide notice that a certain action or event could damage hardware or cause data loss.

Expand Down
Loading