doc(GUIDE): update examples for the latest release (15.1.0) - #3460
Open
Cycle1337 wants to merge 1 commit into
Open
doc(GUIDE): update examples for the latest release (15.1.0)#3460Cycle1337 wants to merge 1 commit into
Cycle1337 wants to merge 1 commit into
Conversation
GUIDE.md pinned ripgrep 0.7.1 (which used clap) but its examples searched for lexopt (the current arg parser), so following the guide yielded no matches. Per BurntSushi#3448, update the guide to the latest release: - Bump the pinned source archive from 0.7.1 to 15.1.0 and refresh the ls output to the current top-level layout (crates/, fuzz/, etc.). - Regenerate every README.md search example (fast, fast\w+, fast\w*, --replace, --only-matching, capturing/named groups) against the 15.1.0 README using rg 15.1.0, so shown line numbers and content match actual output. - Rework the 'fn write\(' walkthrough: the source no longer has a top-level src/ or in-tree termcolor/, so the example and prose now use the crates/ workspace layout (limiting the scoped search to crates/printer). Refs BurntSushi#3448
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
1 participant
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.
Closes #3448
As noted in #3448, GUIDE.md pinned ripgrep 0.7.1 (which used
clap) while its examples searched forlexopt(the parser switched to in later releases), so following the guide produced no matches. This updates the guide to the latest release (15.1.0) per the direction in #3448 (comment) ("the examples should just be updated for the latest release").Changes (all in GUIDE.md):
lsblock to the current top-level layout (crates/,fuzz/,FAQ.md, etc.).README.mdsearch example against the 15.1.0 README usingrg15.1.0, so displayed line numbers/content match actual output:rg fast,rg 'fast\w+',rg 'fast\w*',rg fast --replace/-r FAST,rg '^.*fast.*$' -r FAST,rg fast --only-matching --replace FAST,rg 'fast\s+(\w+)' -r 'fast-$1',rg 'fast\s+(?P<word>\w+)' -r 'fast-$word'.rg 'fn write\('walkthrough: 0.7.1's top-levelsrc/and in-treetermcolor/no longer exist, so the example/prose now reference thecrates/workspace and limit the scoped search tocrates/printer.The
lexoptexamples were already correct for current source and are left unchanged. All command outputs were produced by running ripgrep 15.1.0 on the 15.1.0 source tree (GUIDE.md's own self-matches in thefn write\(example are omitted, matching the existing convention).