Skip to content

Uniform command descriptions' format#57

Merged
joaopalet merged 9 commits into
mainfrom
jp/uniform-long-descriptions
Feb 5, 2024
Merged

Uniform command descriptions' format#57
joaopalet merged 9 commits into
mainfrom
jp/uniform-long-descriptions

Conversation

@joaopalet
Copy link
Copy Markdown
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
Copy Markdown
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

Comment thread internal/cmd/dns/record-set/update/update.go Outdated
Comment thread internal/cmd/dns/zone/update/update.go Outdated
Comment thread internal/cmd/organization/member/remove/remove.go Outdated
Comment thread internal/cmd/project/list/list.go Outdated
Comment thread internal/cmd/ske/options/options.go Outdated
@hcsa73
Copy link
Copy Markdown
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
Comment thread internal/cmd/mongodbflex/user/reset-password/reset_password.go Outdated
Comment thread internal/cmd/organization/member/remove/remove.go Outdated
Comment thread internal/cmd/project/member/remove/remove.go Outdated
Co-authored-by: Henrique Santos <118177985+hcsa73@users.noreply.github.com>
joaopalet and others added 3 commits February 5, 2024 15:44
Co-authored-by: Henrique Santos <118177985+hcsa73@users.noreply.github.com>
Co-authored-by: Henrique Santos <118177985+hcsa73@users.noreply.github.com>
@joaopalet joaopalet merged commit 4897784 into main Feb 5, 2024
@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