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

Update diagnostics package readme file #475

Merged
merged 2 commits into from
Jan 2, 2025
Merged

Update diagnostics package readme file #475

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
aa672af
Update parameter default values, format text
miloszlagan Jan 2, 2025
48214af
Fix grammar
miloszlagan Jan 2, 2025
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
6 changes: 3 additions & 3 deletions husarion_ugv_diagnostics/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Package containing nodes monitoring and publishing the Built-in Computer status

### system_monitor_node

Publishes the built-in computer system status , monitoring parameters as such as CPU usage, RAM usage, disk usage, and CPU temperature.
Publishes the built-in computer system status, monitoring parameters as such as CPU usage, RAM usage, disk usage, and CPU temperature.
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue

Fix grammatical error in the description

The phrase "parameters as such as" contains redundant words.

Apply this change:

-Publishes the built-in computer system status, monitoring parameters as such as CPU usage, RAM usage, disk usage, and CPU temperature.
+Publishes the built-in computer system status, monitoring parameters such as CPU usage, RAM usage, disk usage, and CPU temperature.
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
Publishes the built-in computer system status, monitoring parameters as such as CPU usage, RAM usage, disk usage, and CPU temperature.
Publishes the built-in computer system status, monitoring parameters such as CPU usage, RAM usage, disk usage, and CPU temperature.
🧰 Tools
🪛 LanguageTool

[grammar] ~17-~17: The preposition ‘as’ is repeated. Make sure that it is correct.
Context: ...er system status, monitoring parameters as such as CPU usage, RAM usage, disk usage, and C...

(IN_DT_IN)


#### Publishes

Expand All @@ -25,6 +25,6 @@ Publishes the built-in computer system status , monitoring parameters as such as

- `cpu_usage_warn_threshold` [*float*, default: **95.0**]: Threshold for CPU usage warning in percentage.
- `cpu_temperature_warn_threshold` [*float*, default: **80.0**]: Threshold for CPU temperature warning in degrees Celsius.
- `ram_usage_warn_threshold` [*float*, default: **95.0**]: Threshold for memory usage warning in percentage.
- `disk_usage_warn_threshold` [*float*, default: **95.0**]: Threshold for disk usage warning in percentage.
- `ram_usage_warn_threshold` [*float*, default: **90.0**]: Threshold for memory usage warning in percentage.
- `disk_usage_warn_threshold` [*float*, default: **90.0**]: Threshold for disk usage warning in percentage.
- `publish_frequency` [*double*, default: **5.0**]: System status publishing frequency [Hz].
Loading