fix up & touch up user facing messages #468
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
cfbao
commented
Jul 24, 2024
| .GroupBy( o => $"{o.AccountName}.${o.RoleName}", ( _, entries ) => | ||
| .GroupBy( o => (o.AccountName, o.RoleName), ( _, entries ) => |
There was a problem hiding this comment.
Somewhat unrelated - this isn't a user-facing message, but it's also a string-related issue.
- Value tuples are preferred when we want to use multiple values as a single key. Converting them to a single string is unnecessary and has more overhead.
- Even if we do want to use a string here, it should've been
A common mistake when using C# interpolated strings.
-$"{o.AccountName}.${o.RoleName}" +$"{o.AccountName}.{o.RoleName}"
Comment on lines
-21
to
+25
| Console.Error.Write( $"WARNING: Failed to load the global config file {configFileName}." ); | ||
| consoleWriter.WriteWarning( $"WARNING: Failed to load the global config file {configFileName}." ); |
There was a problem hiding this comment.
It's hard to reproduce such a failure scenario so it's never manifested, but Console.Error.Write (without a newline) would've never worked nicely.
Comment on lines
-91
to
+94
| throw new BmxException( | ||
| $"Okta authentication for user '{username}' in org '{org}'" | ||
| + "failed. Check if org, user, and password is correct" ); | ||
| throw new BmxException( $""" | ||
| Okta authentication for user '{username}' in org '{org}' failed. | ||
| Check if org, user, and password is correct. | ||
| """ ); |
There was a problem hiding this comment.
This one was missing a space before "failed", and the usage of period was inconsistent:
Easier (and clearer, I think) to use a raw string literal with multiple lines instead.
cfbao
requested review from
boarnoah,
scowing,
jharoutuniand2l,
jkomonen and
gord5500
cfbao
changed the title
gord5500
approved these changes
Jul 24, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Noticed some minor issues with user-facing messages.
https://desire2learn.atlassian.net/browse/VUL-403