Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

show examples in the README #76

Closed
StefanoD opened this issue Sep 25, 2016 · 2 comments
Closed

show examples in the README #76

StefanoD opened this issue Sep 25, 2016 · 2 comments
Labels
doc An issue with or an improvement to documentation.

Comments

@StefanoD
Copy link

I couldn't find an example like a preview of search and replace. That is what it would do if rg would really replace the string. This would be really helpful in order to prevent unexpected behaviour.

@BurntSushi
Copy link
Owner

I agree. ripgrep's docs could, in general, be improved a great deal. Adding examples that not only show the command but the output as well would be very beneficial.

@BurntSushi BurntSushi changed the title Preview of search and replace show examples in the README Sep 25, 2016
@BurntSushi BurntSushi added the doc An issue with or an improvement to documentation. label Sep 25, 2016
@BurntSushi
Copy link
Owner

ripgrep's documentation was overhauled in #785. There is now a user guide and a FAQ, both of which contains examples, including an entire section dedicated to replacements.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc An issue with or an improvement to documentation.
Projects
None yet
Development

No branches or pull requests

2 participants