Use a less ambiguous separator for the version update suggestions #327
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
|
No acknowledgment for 2 weeks. Is it normal for this repo's contribution process? |
|
Thoughts on also wrapping each patched version in quotes? |
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.
Suggesting a change to the separator of multiple patched versions in the
Solution:line. The reason being that the output for some CVEs may look very misleading. An example case is this advisory which uses a comma in the suggested constraint of the gem version. Currently, this leads the auditor to print out this line:This may trick the reader into thinking that either one can be chosen when really the suggestions are joined using a comma making it harder to discern them. This change uses the word
oras the separator which should be more obvious to the reader.