docs: split From binary install steps into copy-paste-friendly blocks (#96)#159
Open
mvanhorn wants to merge 1 commit into
Open
Conversation
Member
|
DCO check is failing |
mvanhorn
force-pushed
the
docs/zsh-friendly-install-instructions-issue-96
branch
3 times, most recently
from
July 10, 2026 16:16
b41cd28 to
72792a9
Compare
…lima-vm#96) The current "From binary" install snippet is one large bash code block that mixes commands with `# ...` comments. Interactive zsh treats `#` as a literal token unless `setopt interactivecomments` is set, so a user who copies the whole block and pastes it gets stuck on an unmatched single quote ("GitHub's gh command"), which the issue reproduced. Following the format proposed in the issue (and accepted by jandubois), split each step into its own ```bash block with the explanatory comment moved out into surrounding prose. Each block is now independently copy-pasteable in zsh without needing interactivecomments enabled, and the prose continues to document what each step does. No commands changed; only the prose/code structure of the section. Fixes lima-vm#96 Signed-off-by: Matt Van Horn <mvanhorn@gmail.com> Signed-off-by: Matt Van Horn <455140+mvanhorn@users.noreply.github.com>
mvanhorn
force-pushed
the
docs/zsh-friendly-install-instructions-issue-96
branch
from
July 11, 2026 18:22
72792a9 to
6f6b5df
Compare
AkihiroSuda
reviewed
Jul 15, 2026
| FILE="socket_vmnet-${VERSION:1}-$(uname -m).tar.gz" | ||
| ``` | ||
|
|
||
| # Download the binary archive |
Member
There was a problem hiding this comment.
Alternative ideas to keep it a single block:
- Prepend
[ -n "$ZSH_VERSION" ] && setopt interactive_comments - Or, use
:instead of#
Author
|
DCO is green now, along with all the build, clang-format, and integration checks. Ready for a re-review whenever you have a moment - thanks! |
Member
|
@mvanhorn PTAL |
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.
Fixes #96.
What changed
The "From binary" install snippet in the README was one bash block that interleaved commands with
# ...comments. Split it into separate blocks per step, with the explanatory text moved out into surrounding prose.Why this matters
Interactive zsh does not treat
#as a comment unless the user has runsetopt interactivecomments. Pasting the original block into a default-config zsh produces:…stuck on the unmatched apostrophe in
# (Optional) Attest the GitHub Artifact Attestation using GitHub's gh command (...). The issue reproduced this exactly.The format used here matches the proposal from #96 that @jandubois agreed to ("Works for me. It requires a bunch of clicking and pasting instead of copying it all at once, but I think that is fine."). Each step now stands as its own copy-pasteable block, and the comments become regular prose so they render normally instead of being inside the code fence.
Verification
```fence count is even (verified post-edit).(Optional)steps are still clearly marked as optional.