Show a tested full end-to-end example #5
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
chickenandpork
force-pushed
the
feat/full-examples
branch
3 times, most recently
from
95a12b6
to
86cde14
Compare
chickenandpork
force-pushed
the
feat/full-examples
branch
3 times, most recently
from
1c35fea
to
6d0bbeb
Compare
Merged
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.
When looking at examples, I sometimes see what looks like an aggressively abbreviated example, leaving some details to be assumed or guessed. Additionally, some examples simply no longer work.
This PR adds a full end-to-end example, a CI step that builds it every PR to ensure no bit-rot, and does so in a pattern that permits additional examples to be added to help show usage.
This is orthogonal to swapping
stedolantojqlang, and upgrading1.6to1.7, which will be addressed in peer PRs.Note that a bunch of these changes came in by re-activating some listing and reformatting that the upstream hadn't recently done. See also #6 that helps the formatting not fight with doc generation.