Skip to content

fix: Update component crates descriptions#3317

Merged
Bravo555 merged 1 commit intothin-edge:mainfrom
Bravo555:improve/compmonent-crates-descriptions
Jan 9, 2025
Merged

fix: Update component crates descriptions#3317
Bravo555 merged 1 commit intothin-edge:mainfrom
Bravo555:improve/compmonent-crates-descriptions

Conversation

@Bravo555
Copy link
Copy Markdown
Member

@Bravo555 Bravo555 commented Jan 8, 2025

Proposed changes

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)

Here's how the help text looks now:

Run thin-edge services and plugins

Usage: tedge run [OPTIONS] <COMMAND>

Commands:
  tedge-mapper              tedge-mapper translates thin-edge.io data model to c8y/az/aws data model
  tedge-agent               tedge-agent interacts with a Cloud Mapper and one or more Software Plugins
  c8y-firmware-plugin       thin-edge device firmware management for Cumulocity
  tedge-watchdog            tedge-watchdog checks the health of all the thin-edge.io components/services
  c8y-remote-access-plugin  thin-edge.io plugin for the Cumulocity IoT's Cloud Remote Access feature
  tedge-write               tee-like helper for writing to files which `tedge` user does not have write permissions to
  help                      Print this message or the help of the given subcommand(s)

Types of changes

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Improvement (general improvements like code refactoring that doesn't explicitly fix a bug or add any new functionality)
  • Documentation Update (if none of the other choices apply)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)

Paste Link to the issue

Checklist

  • I have read the CONTRIBUTING doc
  • I have signed the CLA (in all commits with git commit -s)
  • I ran cargo fmt as mentioned in CODING_GUIDELINES
  • I used cargo clippy as mentioned in CODING_GUIDELINES
  • I have added tests that prove my fix is effective or that my feature works
  • I have added necessary documentation (if appropriate)

Further comments

The descriptions could be improved further:

  • the description starting with the name of the component is redundant; the name is already on the left of it, so it could be removed
  • if the name of the component is removed, we could capitalize the sentence to be more consistent with what clap already does (help description is capitalized)
  • a more structured and consistent indication of whether or not something is a plugin and what it entails

@Bravo555 Bravo555 temporarily deployed to Test Pull Request January 8, 2025 13:19 — with GitHub Actions Inactive
@Bravo555 Bravo555 added the theme:cli Theme: cli related topics label Jan 8, 2025
@codecov
Copy link
Copy Markdown

codecov bot commented Jan 8, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Additional details and impacted files

📢 Thoughts on this report? Let us know!

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Jan 8, 2025

Robot Results

✅ Passed ❌ Failed ⏭️ Skipped Total Pass % ⏱️ Duration
551 0 2 551 100 1h32m42.360430999s

@didier-wenzek didier-wenzek changed the title cli: Update compmonent crates descriptions cli: Update component crates descriptions Jan 9, 2025
[package]
name = "c8y-firmware-plugin"
description = "Thin-edge device firmware management for Cumulocity"
description = "thin-edge device firmware management for Cumulocity"
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
description = "thin-edge device firmware management for Cumulocity"
description = "thin-edge.io device firmware management for Cumulocity"

[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"
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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"

@Bravo555 Bravo555 force-pushed the improve/compmonent-crates-descriptions branch from b4af234 to 8dde0f2 Compare January 9, 2025 11:36
@Bravo555 Bravo555 requested a review from a team as a code owner January 9, 2025 11:36
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>
@Bravo555 Bravo555 force-pushed the improve/compmonent-crates-descriptions branch from 8dde0f2 to e20da5b Compare January 9, 2025 11:37
@Bravo555 Bravo555 temporarily deployed to Test Pull Request January 9, 2025 11:37 — with GitHub Actions Inactive
@Bravo555 Bravo555 enabled auto-merge January 9, 2025 11:38
@Bravo555 Bravo555 added this pull request to the merge queue Jan 9, 2025
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Jan 9, 2025
@Bravo555 Bravo555 added this pull request to the merge queue Jan 9, 2025
Merged via the queue into thin-edge:main with commit 7ce1794 Jan 9, 2025
@reubenmiller reubenmiller changed the title cli: Update component crates descriptions fix: Update component crates descriptions Jan 15, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

theme:cli Theme: cli related topics

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants