Conversation
- exceptions.md: remove duplicate article "the a" → "a" in
"Triggering the a help page"
- shell-completion.md: add missing closing quote in f-string
code example (`f"{item.type},{item.value}` →
`f"{item.type},{item.value}"`)
davidism
changed the title
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
3 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.
What
Fix two small typos in the documentation:
docs/exceptions.mdline 90: remove duplicate articleTriggering the a help page intentionally...Triggering a help page intentionally...docs/shell-completion.mdline 228: add missing closing"in the f-string code example`f"{item.type},{item.value}`(invalid Python — unclosed string)`f"{item.type},{item.value}"`(matches the actual source inshell_completion.py:366)Why
The double article "the a" is a clear grammatical error. The missing
"in the f-string example makes the documented return value look like invalid Python syntax — the real implementation (shell_completion.pyline 366) correctly has the closing quote.