Use YAML literal block syntax for description, rationale #1140
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
This prevents some syntax issues with YAML, e.g. '#' can be used in a literal block without being treated as a line comment. The switch from PyYAML to ruamel.yaml was needed to validate the syntax style.
martinthomson
approved these changes
Dec 9, 2024
Comment on lines
84
to
+85
| if not isinstance(item['bug'], str) or not item['bug'].startswith("https://bugzilla.mozilla.org/show_bug.cgi?id="): | ||
| self.log_error(f"'bug' must be a URL starting with 'https://bugzilla.mozilla.org/show_bug.cgi?id=', got {item['bug']}", key, line) | ||
| self.log_error(f"'bug' must be a URL starting with 'https://bugzilla.mozilla.org/show_bug.cgi?id=', got {item['bug']}.", key) |
There was a problem hiding this comment.
If we're requiring this, why not include just the bug number (and take the https://bugzilla... as implied?)
Not for this change, but as a followup perhaps.
There was a problem hiding this comment.
I think it's easier for contributors to paste the full URL for all of the URLs than to find out what substring should be used. Though new issues will have the URLs in the issue OP instead, so it doesn't matter so much.
| if 'caniuse' in item and item['caniuse'] not in [None, '']: | ||
| if not isinstance(item['caniuse'], str) or not item['caniuse'].startswith("https://caniuse.com/"): | ||
| self.log_error(f"'caniuse' must be a URL starting with 'https://caniuse.com/' or empty, got {item['caniuse']}", key, line) | ||
| self.log_error(f"'caniuse' must be a URL starting with 'https://caniuse.com/', got {item['caniuse']}.", key) |
|
|
||
| if 'mdn' in item and item['mdn'] not in [None, '']: | ||
| if not isinstance(item['mdn'], str) or not item['mdn'].startswith("https://developer.mozilla.org/en-US/"): | ||
| self.log_error(f"'mdn' must be a URL starting with 'https://developer.mozilla.org/en-US/', got {item['mdn']}.", key) |
| data[key][field] = LiteralScalarString(value) | ||
| else: | ||
| self.log_error(f"'{field}' must use literal block syntax (|).", key) | ||
| elif not value.endswith('\n'): |
There was a problem hiding this comment.
Is it even possible to have a value that doesn't have a trailing \n?
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.
This prevents some syntax issues with YAML, e.g. '#' can be used in a literal block without being treated as a line comment.
The switch from PyYAML to ruamel.yaml was needed to validate the syntax style.