Document quote escaping and fix misleading regex-hint example - #156
Merged
Conversation
|
Coverage after merging docs/quote-escaping-regex-hint into fix/derive-segment-text will be
Coverage Report
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
🔦 Lighthouse Report
|
shouze
changed the title
shouze
force-pushed
the
docs/quote-escaping-regex-hint
branch
from
August 23, 2026 13:58
953e512 to
d33ee36
Compare
|
Coverage after merging docs/quote-escaping-regex-hint into fix/derive-segment-text will be
Coverage Report
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
1 similar comment
|
Coverage after merging docs/quote-escaping-regex-hint into fix/derive-segment-text will be
Coverage Report
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the documentation to accurately explain GitHub quote escaping (including the CLI’s fast-fail behavior for unbalanced quotes) and replaces a misleading --regex-hint example with one that actually needs a manual hint. It also updates the VitePress landing-page “Semver / version audit” use case copy to reflect the improved quote-preserving behavior for regex-derived API terms.
Changes:
- Expand
docs/usage/search-syntax.mdwith a new section covering literal"searches, double-escaping (shell + GitHub), and the unbalanced-quote 422 troubleshooting flow. - Replace the
--regex-hint '"axios"'example with a non-literal regex example that genuinely requires a hint, plus a tip explaining why single-word quoting doesn’t narrow GitHub search. - Update the landing-page “Semver / version audit” use case description to mention automatic escaping of quotes in regex patterns.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/usage/search-syntax.md | Adds/adjusts documentation for literal quote escaping, quote-balance troubleshooting, and a corrected --regex-hint example. |
| docs/.vitepress/theme/UseCaseTabs.vue | Updates the Semver/version-audit use case description to match the improved quote-preserving behavior. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
shouze
force-pushed
the
docs/quote-escaping-regex-hint
branch
from
August 23, 2026 14:26
d33ee36 to
0033268
Compare
|
Coverage after merging docs/quote-escaping-regex-hint into fix/derive-segment-text will be
Coverage Report
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
1 similar comment
|
Coverage after merging docs/quote-escaping-regex-hint into fix/derive-segment-text will be
Coverage Report
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
shouze
force-pushed
the
docs/quote-escaping-regex-hint
branch
from
August 23, 2026 14:36
0033268 to
270dc31
Compare
|
Coverage after merging docs/quote-escaping-regex-hint into fix/derive-segment-text will be
Coverage Report
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
1 similar comment
|
Coverage after merging docs/quote-escaping-regex-hint into fix/derive-segment-text will be
Coverage Report
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
- Add a new "Searching for a literal quote character" section to docs/usage/search-syntax.md explaining GitHub's double-escaping syntax (shell + GitHub), the difference between balanced and unbalanced raw quotes, and the new local validation error introduced by #149. - Replace the --regex-hint '"axios"' example: wrapping a single word in quotes has zero filtering effect on GitHub's side (verified against the live API), so it was actively misleading. The new example uses a pattern with no literal characters at all, which genuinely requires a hint. - Update the semver/version-audit example note that the double quotes in the pattern are now preserved and escaped automatically instead of being dropped (see #147) — this vitepress landing-page use case previously demonstrated a command that, before this epic's fixes, did not actually behave as advertised. Closes #150
shouze
force-pushed
the
docs/quote-escaping-regex-hint
branch
from
August 23, 2026 14:51
270dc31 to
0322340
Compare
|
Coverage after merging docs/quote-escaping-regex-hint into fix/derive-segment-text will be
Coverage Report
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
1 similar comment
|
Coverage after merging docs/quote-escaping-regex-hint into fix/derive-segment-text will be
Coverage Report
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Sébastien HOUZÉ <sebastien.houze@fulll.fr>
|
Coverage after merging docs/quote-escaping-regex-hint into fix/derive-segment-text will be
Coverage Report
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Sébastien HOUZÉ <sebastien.houze@fulll.fr>
|
Coverage after merging docs/quote-escaping-regex-hint into fix/derive-segment-text will be
Coverage Report
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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.
What does this PR do?
Closes #150.
Adds a new "Searching for a literal quote character" section to
docs/usage/search-syntax.mdexplaining GitHub's double-escaping syntax (shell and GitHub), the difference between balanced and unbalanced raw quotes, and the local validation error introduced by #149.Replaces the
--regex-hint '"axios"'example: wrapping a single word in double quotes has zero filtering effect on GitHub's side (verified against the live API, quoting a single word returns the exact same total_count as the bare word), so the example was actively misleading. The new example uses a pattern with no literal characters at all, which genuinely requires a manual hint.Updates the semver/version-audit use case on the vitepress landing page (
docs/.vitepress/theme/UseCaseTabs.vue) to note that the double quotes in the pattern are now preserved and escaped automatically instead of being dropped (see #147); this landing-page example previously demonstrated a command that, before this epic's fixes, did not actually behave as advertised.How did you verify your code works?
bun run docs:buildlocally; build completes successfully.