Skip to content

String content and var style updates#1393

Merged
Steven Gagniere (sgagniere) merged 18 commits intomainfrom
string-updates
Aug 10, 2022
Merged

String content and var style updates#1393
Steven Gagniere (sgagniere) merged 18 commits intomainfrom
string-updates

Conversation

@sgagniere
Copy link
Member

Checklist

  1. [CRUCIAL] Is the change for CP or CCloud functionalities that are already live in prod?
    • yes: ok

What

Various changes to strings in internal/pkg/errors/strings.go and internal/pkg/errors/error_message.go (and affected files):

  • Typo fixes.
  • Changed (most) error messages to follow guidelines: first word not capitalized (unless it's a proper noun) and no full-stops at the end.
  • Changed (most) suggestion messages to follow guidelines: first word capitalized and a full stop at the end of each sentence.
  • Removed unused strings.
  • Removed newline characters at the end of the last sentence of some suggestions.
  • Added a space between the end of a url and the fullstop in some suggestions to avoid possible confusion about whether or not the fullstop is part of the url.
  • Updated README to reflect these last two styles.
  • Added ErrorMsg suffix to some error string variables which were missing it, and modified the suffix of some strings being used as error messages from Msg to ErrorMsg.
  • Changed the suffix of some suggestions from Suggestion to Suggestions to match the README guidelines (even when the suggestion consists of a single sentence).
  • Moved a Msg from error_messages.go to strings.go.

References

N/A

Test & Review

Ran make test.

…alization and full stops to match guidelines in README.md
…ErrorMsg since they were used as errors, and moved a non-error message from error_message.go to strings.go
…od, and modified the README guidelines to reflect this
… semicolon and removed capitalization/fullstop
@sgagniere Steven Gagniere (sgagniere) requested a review from a team as a code owner August 9, 2022 20:36
Copy link
Contributor

@DABH David Hyde (DABH) left a comment

Choose a reason for hiding this comment

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

Looks good, thanks for the cleanup! ✨

@@ -1 +1 @@
Error: Audit Logs are not enabled for this organization.
Error: Audit Logs are not enabled for this organization
Copy link
Contributor

Choose a reason for hiding this comment

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

Why did this one lose a period but the one below gained a period? (Conservation laws aside...)

Copy link
Member Author

Choose a reason for hiding this comment

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

This one's an error, so it doesn't have an ending period. The next one (assuming it's describe-invalid-role-cloud.golden is a suggestion, so I added one.

@sgagniere Steven Gagniere (sgagniere) deleted the string-updates branch August 10, 2022 19:07
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