Repository navigation
docs: add yqlib API usage example to README - #2907
Open
victorwon2001 wants to merge 1 commit into
Open
victorwon2001 wants to merge 1 commit into
victorwon2001 wants to merge 1 commit into
Conversation
|
@mikefarah this PR looks popular: it has a score of 7 (threshold 3).
Automated by the Popular PRs workflow (deterministic, no LLM). Excludes the PR author, the maintainer and bots. |
This branch has not been deployed
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
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.
AI disclosure: an automated workflow using gpt-6-thinking prepared this contribution on the account holder's behalf, not the account holder personally. Code writing, review, and correspondence, including drafting this text, are handled through that automated workflow.
Summary
pkg/yqlibexample alongside the existing CLI installation instructions, including the module dependency and import path.EvaluateNodes, and print the updated YAML, checking errors at each stage.Testing
The README example compiled, emitted the documented YAML, and exited with an error for an invalid expression; focused evaluation tests, the remaining Go tests, spelling, and a clean-source module ZIP check passed. The complete test script still fails on an unrelated JSON parser error-message assertion and because ignored task-local caches make the working source tree exceed the ZIP size limit.
Fixes #2021