Skip to content

Commit

Permalink
Update descriptions of crates containing runnable components
Browse files Browse the repository at this point in the history
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 <[email protected]>
  • Loading branch information
Bravo555 committed Jan 9, 2025
1 parent 157e8d3 commit 8dde0f2
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion crates/core/tedge_mapper/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "tedge-mapper"
description = "tedge-mapper is the mapper that translates thin-edge.io data model to c8y/az data model."
description = "tedge-mapper translates thin-edge.io data model to c8y/az/aws data model"
version = { workspace = true }
authors = { workspace = true }
edition = { workspace = true }
Expand Down
2 changes: 1 addition & 1 deletion crates/core/tedge_watchdog/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "tedge-watchdog"
description = "tedge-watchdog checks the health of all the thin-edge.io components/services."
description = "tedge-watchdog checks the health of all the thin-edge.io components/services"
version = { workspace = true }
authors = { workspace = true }
edition = { workspace = true }
Expand Down
2 changes: 1 addition & 1 deletion plugins/c8y_firmware_plugin/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "c8y-firmware-plugin"
description = "Thin-edge device firmware management for Cumulocity"
description = "thin-edge.io device firmware management for Cumulocity"
version = { workspace = true }
authors = { workspace = true }
edition = { workspace = true }
Expand Down
2 changes: 1 addition & 1 deletion plugins/c8y_remote_access_plugin/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[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 Cloud Remote Access feature"
version = { workspace = true }
authors = { workspace = true }
edition = { workspace = true }
Expand Down

0 comments on commit 8dde0f2

Please sign in to comment.