docs(README): fix removed $ sign in the ins#976
Merged
tony merged 1 commit intotmux-python:masterfrom Mar 14, 2025
isandesh7:patch-1
Merged
docs(README): fix removed $ sign in the ins#976tony merged 1 commit intotmux-python:masterfrom isandesh7:patch-1
tony merged 1 commit intotmux-python:masterfrom
isandesh7:patch-1
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.
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.
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:
|
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
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.
The $ sign makes the copy button useless. removing it.
it copies over the $ causing the command to fail when copied.
Summary by Sourcery
Documentation: