Don't use the word "trace" in log messages #302
Merged
Conversation
This file contains hidden or 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
sampart
approved these changes
Nov 13, 2020
Co-authored-by: Sam Partington <sampart@github.com>
shati-patel
reviewed
Nov 13, 2020
lib/runner.js
Outdated
| fs.writeFileSync(powershellEnvFile, powershellEnvFileContents); | ||
| logger.info(`\nCodeQL environment output to "${jsonEnvFile}", "${batEnvFile}" and "${powershellEnvFile}". ` + | ||
| `Please export these variables to future processes so the build can be traced. ` + | ||
| `Please export these variables to future processes so the build can be monitored by CodeQL. ` + |
There was a problem hiding this comment.
Very optional suggestion:
Suggested change
| `Please export these variables to future processes so the build can be monitored by CodeQL. ` + | |
| `Please export these variables to future processes so that CodeQL can monitor the build. ` + |
Using active voice (i.e. "CodeQL can monitor" rather than "monitored by CodeQL") might be a bit clearer?
shati-patel
approved these changes
Nov 13, 2020
shati-patel
left a comment
shati-patel
left a comment
There was a problem hiding this comment.
Thanks, this looks good! I added a small comment, but feel free to ignore 😉
Merged
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.
@shati-patel, does this wording look ok to you? The basic suggestion was to use "monitoring" instead, and I can't think of anything better.
Happy for @shati-patel to approve, or alternatively @sampart if you could give official approval.
Merge / deployment checklist