fix: use placeholders for the remote URL examples in validate/import help#702
Open
ivanauth wants to merge 1 commit into
Open
fix: use placeholders for the remote URL examples in validate/import help#702ivanauth wants to merge 1 commit into
ivanauth wants to merge 1 commit into
Conversation
…thzed#487) The validate/import help examples hardcoded specific playground, gist, and pastebin URLs. The playground link had rotted, so copy-pasting it failed; the others can rot the same way. Swap all three for fill-in-the-blank placeholders (YOUR_SHARE_ID, etc.) so the features stay discoverable without going stale. The fetch path itself works and is covered by decoder_test.go. Also drops a disabled url_passes test pinned to the dead link, and regenerates docs/zed.md.
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
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.
The help for
zed validateandzed importhad a hardcoded playground link in the examples, and that share has gone stale, so if you copy paste it you just get a parse error. The gist and pastebin ones next to it will probably rot the same way eventually.The feature itself is fine btw, the playground URL handling still works and is tested in decoder_test.go, it's only the baked-in link that died. So instead of removing the example I just swapped all three over to placeholders (YOUR_SHARE_ID and so on) so they still show up in --help but can't go stale.
Also dropped an old disabled url_passes test that pointed at the same dead link (it's already covered in decoder_test) and regenerated docs/zed.md.
Fixes #487