Skip to content

docs: refine command usage statements #1331

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.

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

Open
wants to merge 2 commits into
base: dev
Choose a base branch
from

Conversation

Octobug
Copy link
Contributor

@Octobug Octobug commented May 6, 2025

  • Removed redundant comments.
  • Update some command usage statements

See #1330 for backgroud details.

The codes are self-documenting enough.
@Octobug Octobug changed the base branch from main to dev May 6, 2025 12:13
@Octobug Octobug marked this pull request as draft May 6, 2025 12:13
@Octobug Octobug force-pushed the docs/cmd-usage-statements branch 2 times, most recently from 03dd901 to cf49b11 Compare May 6, 2025 17:28
@Octobug Octobug changed the title Docs/cmd usage statements docs: refine command usage statements May 6, 2025
@Octobug Octobug marked this pull request as ready for review May 8, 2025 15:03
@Octobug Octobug marked this pull request as draft May 8, 2025 15:05
@Octobug Octobug force-pushed the docs/cmd-usage-statements branch from cf49b11 to 636d410 Compare May 8, 2025 15:11
@Octobug Octobug marked this pull request as ready for review May 8, 2025 15:11
cmd/command.go Outdated
@@ -68,7 +68,7 @@ func init() {

buildCmd.Flags().StringVarP(&buildDir, "build-dir", "b", "", "dir for build process")

upgradeCmd.Flags().StringVarP(&upgradeVersion, "from", "f", "", "upgrade from specific version, eg: -f v1.1.0")
upgradeCmd.Flags().StringVarP(&upgradeVersion, "from", "f", "", "upgrade to the specific version from your input, eg: -f v1.1.0")
Copy link
Member

Choose a reason for hiding this comment

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

There is a slight misunderstanding in the description of the upgrade command here. For example, if the command is answer upgrade -f v1.3.5, it means that answer will be upgraded from v1.3.5 to the latest version(The current version of the binary). So it's not you describing an upgrade to a specified version.

Copy link
Contributor Author

@Octobug Octobug May 9, 2025

Choose a reason for hiding this comment

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

Oh...Okay, actually I especially checked how the upgradeVersion var was used. It turns out that I misunderstood this comment line and the function signature... 😂 I'll recover its description.

@Octobug Octobug force-pushed the docs/cmd-usage-statements branch from 636d410 to 405f794 Compare May 9, 2025 15:55
@Octobug Octobug force-pushed the docs/cmd-usage-statements branch from 405f794 to 75c5c89 Compare May 9, 2025 15:58
@Octobug Octobug requested a review from LinkinStars May 9, 2025 16:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants