Change tutorial to highlight filter part of query versus output part of query #1460
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
…is the pattern matching part and the left side is the output format
|
Travis-ci error is the same error seen on master so I believe the problem is upstream. |
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.
Intent of this change is to let the reader who is totally unfamiliar with the JQ syntax see how the input JSON is filtered during a query by the right side of the of the syntax and the output is specified by the left side. In the current tutorial, the search filter is
.commit.messageand the output is
message:The word message is used in both the search side and the output side and might confuse a new user to try to search JSON input with the left side. (It has happened to me a few times after leaving JQ coding for a few months). With this patch, search remains the same but "message" turns into "comment" and "committer" turns into "contributor" showing the reader that the left side is clearly output and the right side is the search.
The configure.ac change is to keep autoconf syntax highlighters from getting confused.