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 typo & udev rules command in README #31

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

rickwierenga
Copy link

@rickwierenga rickwierenga commented Nov 6, 2024

with echo .. | sudo tee writing is a sudo operation. input redirection uses the user's permission, which might not be sufficient. this change allows easier copy paste

Summary by Sourcery

Documentation:

  • Correct the udev rules command in the README to use 'echo' with 'sudo tee' for proper permission handling.

Copy link

sourcery-ai bot commented Nov 6, 2024

Reviewer's Guide by Sourcery

This PR fixes documentation issues in the README.md file, specifically addressing a command syntax issue for setting up udev rules and correcting a typo. The main change improves the reliability of the udev rules setup command by using the tee approach instead of direct redirection with sudo.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Updated the udev rules setup command to use tee instead of direct redirection
  • Changed command syntax from 'sudo echo ... > file' to 'echo ...
sudo tee file'
  • Removed redundant alternative section since it now matches the main command
  • Fixed a typo in the documentation
    • Corrected spelling of 'Aleternative' to 'Alternative'
    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.
    • Generate a pull request title: Write @sourcery-ai anywhere in the pull
      request title to generate a 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. You can also use
      this command to specify where the summary should be inserted.

    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

    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 @rickwierenga - I've reviewed your changes and they look great!

    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.

    @rickwierenga
    Copy link
    Author

    sorry, just saw that that is what is in the collapsable. why not make that the default?

    @rickwierenga
    Copy link
    Author

    it might also be nice to add

    sudo udevadm control --reload-rules
    sudo udevadm trigger
    

    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.

    1 participant