fix: Update component crates descriptions#3317
Merged
Bravo555 merged 1 commit intothin-edge:mainfrom Jan 9, 2025
Merged
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅ Additional details and impacted files📢 Thoughts on this report? Let us know! |
didier-wenzek
approved these changes
Jan 8, 2025
Contributor
Robot Results
|
albinsuresh
approved these changes
Jan 9, 2025
reubenmiller
reviewed
Jan 9, 2025
| [package] | ||
| name = "c8y-firmware-plugin" | ||
| description = "Thin-edge device firmware management for Cumulocity" | ||
| description = "thin-edge device firmware management for Cumulocity" |
Contributor
There was a problem hiding this comment.
Suggested change
| description = "thin-edge device firmware management for Cumulocity" | |
| description = "thin-edge.io device firmware management for Cumulocity" |
reubenmiller
reviewed
Jan 9, 2025
| [package] | ||
| name = "c8y-remote-access-plugin" | ||
| description = "Thin-edge.io plugin for the Cumulocity IoT's Cloud Remote Access feature" | ||
| description = "thin-edge.io plugin for the Cumulocity IoT's Cloud Remote Access feature" |
Contributor
There was a problem hiding this comment.
Suggested change
| description = "thin-edge.io plugin for the Cumulocity IoT's Cloud Remote Access feature" | |
| description = "thin-edge.io plugin for the Cumulocity Cloud Remote Access feature" |
b4af234 to
8dde0f2
Compare
Description of these crates is shown by clap in CLI help, so the descriptions were updated to make them more consistent. - a trailing dot `.` was removed (looking at most popular Rust crates at https://lib.rs/std, none of those that have only a single sentence have a trailing dot) - the descriptions were uncapitalized (they consist of a single sentence anyway and sometimes start with `thin-edge`) Signed-off-by: Marcel Guzik <marcel.guzik@cumulocity.com>
8dde0f2 to
e20da5b
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Proposed changes
Description of these crates is shown by clap in CLI help, so the descriptions were updated to make them more consistent.
.was removed (looking at most popular Rust crates at https://lib.rs/std, none of those that have only a single sentence have a trailing dot)thin-edge)Here's how the help text looks now:
Types of changes
Paste Link to the issue
Checklist
cargo fmtas mentioned in CODING_GUIDELINEScargo clippyas mentioned in CODING_GUIDELINESFurther comments
The descriptions could be improved further:
helpdescription is capitalized)