8000 Documentation should include common example use cases with explanations · Issue #166 · machakann/vim-sandwich · GitHub

More Web Proxy on the site http://driver.im/

Documentation should include common example use cases with explanations #166

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.

Sign up for GitHub

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

Jump to bottom

Open

pmatulis opened this issue Oct 13, 2023 · 4 comments

pmatulis commented

Thanks for the plugin. However, I'm finding it hard to engage. Can we get examples of common use case recipes with explanations? For example:

surrounding a visual selection
surrounding the current line

Contributor

Konfekt commented

Maybe vim-surround's introduction gets one started faster?

Author

pmatulis commented

Examples speak volumes. Having to read through all this to figure out how to do a few simple things is not what many are willing to do.

Contributor

Konfekt commented

@machakann , how about adding examples at the top of the README in an accompanying pull request?

Owner

machakann commented

Thanks. PR is always welcome. I will take it in a few months if no one touches it.

Konfekt mentioned this issue

add examples similar to surround.vim #170

Merged

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

0