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

docs(README): fix removed $ sign in the ins #976

Merged
merged 1 commit into from
Mar 14, 2025

Conversation

isandesh7
Copy link
Contributor

@isandesh7 isandesh7 commented Mar 14, 2025

The $ sign makes the copy button useless. removing it.
it copies over the $ causing the command to fail when copied.

$ pipx install --suffix=@next 'tmuxp' --pip-args '\--pre' --force
pipx install --suffix=@next 'tmuxp' --pip-args '\--pre' --force

Summary by Sourcery

Documentation:

  • Remove '$' prefix from example commands in README.

The $ sign makes the copy button useless. removing it.
Copy link

sourcery-ai bot commented Mar 14, 2025

Reviewer's Guide by Sourcery

The 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

Change Details Files
The '$' sign was removed from the beginning of several lines in the README.md file.
  • Removed '$' from pip install command.
  • Removed '$' from pipx install command.
  • Removed '$' from tmuxp load commands.
README.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@CLAassistant
Copy link

CLAassistant commented Mar 14, 2025

CLA assistant check
All committers have signed the CLA.

Copy link

@sourcery-ai sourcery-ai bot left a 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

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@tony tony self-requested a review March 14, 2025 23:41
Copy link
Member

@tony tony left a 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!

Copy link

codecov bot commented Mar 14, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 73.07%. Comparing base (da00754) to head (e258cc9).
Report is 1 commits behind head on master.

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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@tony tony merged commit ff72574 into tmux-python:master Mar 14, 2025
15 checks passed
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.

3 participants