Document key for exercise files #407
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
ErikSchierboom
commented
Nov 11, 2022
| @@ -312,6 +312,8 @@ This file contains meta information on the exercise: | |||
| - `blurb`: A short description of this exercise. Its length must be <= 350. Markdown is _not_ supported (required) | |||
| - `source`: The source this exercise is based on (optional) | |||
| - `source_url`: The URL of the source this exercise is based on (optional) | |||
| - `representer`: Meta information related to how the representer processes this file (optional) | |||
| - `version`: An integer for the version of the representer to use for the exercise (required if parent key is present) | |||
There was a problem hiding this comment.
Maybe:
An integer which can be incremented to invalidate representations (required if parent key is present - defaults to 1 downstream if missing, so set to 2 to initially invalidate).
There was a problem hiding this comment.
(Ah, here was the famous reply-via-overwriting-edit).
Parsing an omitted version property the same as an explicit "version": 1 sounds OK to me.
Note that configlet lint leaned towards not erroring for an empty optional key, though. So maybe "representer": {} shouldn't be an error. But perhaps removed with configlet fmt.
iHiD
approved these changes
Nov 15, 2022
ee7
approved these changes
Nov 15, 2022
Co-authored-by: ee7 <45465154+ee7@users.noreply.github.com>
ErikSchierboom
added a commit
to ErikSchierboom/docs
that referenced
this pull request
Nov 22, 2022
Document key for exercise iles Co-authored-by: ee7 <45465154+ee7@users.noreply.github.com>
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.
No description provided.