-
Notifications
You must be signed in to change notification settings - Fork 232
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
docs(README): fix removed $ sign in the ins #976
Conversation
The $ sign makes the copy button useless. removing it.
Reviewer's Guide by SourceryThe pull request removes the '$' character from the beginning of several commands in the README.md file. This was done to prevent users from copying the '$' character when copying the commands, which would cause the commands to fail. No diagrams generated as the changes look simple and do not need a visual representation. File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hey @isandesh7 - I've reviewed your changes - here's some feedback:
Overall Comments:
- This is a good change to make the examples more copy/paste friendly.
Here's what I looked at during the review
- 🟢 General issues: all looks good
- 🟢 Security: all looks good
- 🟢 Testing: all looks good
- 🟢 Complexity: all looks good
- 🟢 Documentation: all looks good
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Makes sense, thank you!
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #976 +/- ##
=======================================
Coverage 73.07% 73.07%
=======================================
Files 26 26
Lines 1857 1857
Branches 352 352
=======================================
Hits 1357 1357
Misses 396 396
Partials 104 104 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
The $ sign makes the copy button useless. removing it.
it copies over the $ causing the command to fail when copied.
Summary by Sourcery
Documentation: