docs: improve JSON and YAML example clarity #346#351
Open
Kah2412 wants to merge 1 commit intoaskimed:mainfrom
Open
docs: improve JSON and YAML example clarity #346#351Kah2412 wants to merge 1 commit intoaskimed:mainfrom
Kah2412 wants to merge 1 commit intoaskimed:mainfrom
Conversation
Updated the generic 'key' and 'value' assertions in the JSON and YAML documentation to use more semantic terms like 'tool' and 'version'. This addresses the feedback in issue askimed#346 to make the examples more intuitive for new users.
Collaborator
|
I don't think this makes it more clear that you can specify a key in the JSON file using this method. Could you maybe provide a small JSON object as an example and use this in the explanation? |
Author
|
"Thanks for the feedback! I see your point. I will update the documentation to include a concrete JSON object example and show exactly how to reference a specific key from it. This should make the mapping logic much clearer for everyone. I'll push the changes shortly! |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Updated the generic 'key' and 'value' assertions in the JSON and YAML documentation to use more semantic terms like 'tool' and 'version'. This addresses the feedback in issue #346 to make the examples more intuitive for new users.