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

Fix copiable code snippets in README.md #316

Merged

Conversation

msantl
Copy link
Contributor

@msantl msantl commented Sep 14, 2021

Using the Copy button that Github renders on the code snippets in README.md, ie.
Screenshot 2021-09-14 at 14 52 01
the content copied to the clipboard is $ go get github.com/segmentio/chamber.

Pasting this content won't work because it's prefixed with the $ character.

In this PR, I'm removing all the $ characters from the copiable code snippets so that the Copy button copies the right content.

@asaf-erlich
Copy link
Contributor

Thank you for this fix. Do you need me to merge it as well?

@msantl msantl changed the title Fix the "Installation" code snippet in README.md Fix copiable code snippets in README.md Sep 14, 2021
@msantl
Copy link
Contributor Author

msantl commented Sep 14, 2021

@asaf-erlich Thanks for the quick review. In the meantime, I realized that there are more code snippets that have the same issue so I went ahead and updated all of those. I'll also update the PR summary with all the changes.

Please take another look and feel free to merge the PR (if you think it's good to go).

@asaf-erlich asaf-erlich merged commit 588ca2a into segmentio:master Sep 14, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants