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.

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

Uniform command descriptions' format #57

Merged
merged 9 commits into from
Feb 5, 2024
Merged

Conversation

joaopalet
Copy link
Contributor

@joaopalet joaopalet commented Feb 5, 2024

Rationale followed:

  • Long descriptions always end in a full stop (., !, ...)
  • Command descriptions use a declarative form (e.g. Provides functionality for ..., Creates a ..., Deletes a ...)

hcsa73
hcsa73 previously approved these changes Feb 5, 2024
Copy link
Contributor

@hcsa73 hcsa73 left a comment

Choose a reason for hiding this comment

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

If you change any description, don't forget to regenerate docs

internal/cmd/dns/record-set/update/update.go Outdated Show resolved Hide resolved
internal/cmd/dns/zone/update/update.go Outdated Show resolved Hide resolved
internal/cmd/organization/member/remove/remove.go Outdated Show resolved Hide resolved
internal/cmd/project/list/list.go Outdated Show resolved Hide resolved
internal/cmd/ske/options/options.go Outdated Show resolved Hide resolved
@hcsa73
Copy link
Contributor

hcsa73 commented Feb 5, 2024

Also I think it's a bit weird that some commands' descriptions are in different tenses. I understand the logic, just think it would look best if they were all declarative.

For me it can stay like this, it's better to have some rule and this is fine

hcsa73
hcsa73 previously approved these changes Feb 5, 2024
internal/cmd/organization/member/remove/remove.go Outdated Show resolved Hide resolved
internal/cmd/project/member/remove/remove.go Outdated Show resolved Hide resolved
@joaopalet joaopalet merged commit 4897784 into main Feb 5, 2024
1 check passed
@joaopalet joaopalet deleted the jp/uniform-long-descriptions branch February 5, 2024 15:46
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