docs: split From binary install steps into copy-paste-friendly blocks (#96) - #159
Conversation
|
DCO check is failing |
b41cd28 to
72792a9
Compare
72792a9 to
6f6b5df
Compare
| FILE="socket_vmnet-${VERSION:1}-$(uname -m).tar.gz" | ||
| ``` | ||
|
|
||
| # Download the binary archive |
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#
There was a problem hiding this comment.
Went with the setopt approach in 9da382f: back to a single block, with the guard as the first line so zsh accepts the # comments when pasted. Thanks for the pointer.
|
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! |
|
@mvanhorn PTAL |
|
Please squash the commits |
9da382f to
bf48a52
Compare
|
ping @mvanhorn |
bf48a52 to
a34d18b
Compare
Signed-off-by: Matt Van Horn <455140+mvanhorn@users.noreply.github.com>
a34d18b to
3a06135
Compare
|
Both done, sorry for the lag. Squashed to a single signed-off commit, and rather than splitting the block I went with your first suggestion: it now prepends Ready for a re-review whenever you have a moment. |
2 participants
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.