Repository navigation
docs: put shell notes on their own line, not after the command - #164
Merged
Merged
Conversation
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.
Refs #92
Interactive zsh does not treat
#as a comment unlessinteractivecommentsis on (off by default). So a pastedcmd # noteline passes#and the note tocmd. This PR puts each such note on its own line above the command, and adds a test that finds new ones.Progress
README.md,AGENTS.mdordocs/has a command line that ends in a#comment (19 lines moved: README, AGENTS, setup, both manual tests).docs_test.go,TestDocsShellLinesHaveNoTrailingComment. It runs in the normalgo test ./...in CI.TestTrailingShellCommentschecks the finder itself (quotes,$#, URLs with#, TOML blocks, indented blocks).Choices
go test ./...already, needs no new tool, and runs on every developer's machine too.docs/(not only README, AGENTS and docs/, so that DESIGN.md is covered too), and blocks markedsh,bash,shell,zshorconsole. All shell blocks in the docs are markedsh. TOML and other blocks are not checked (their comments are config, not shell).command not found: #(wheninteractivecommentsis off). That is harmless: no command gets extra words. The issue asks for this form.Review
~~~fences and quotes over many lines; the docs use neither today.