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

Update README.md #2

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Update README.md #2

wants to merge 2 commits into from

Conversation

tdiprima
Copy link

@tdiprima tdiprima commented Dec 6, 2024

Correct repository is ollamautil; not ollama-util. I also added sh to the code tick-marks.

Summary by Sourcery

Update the README to correct the repository name and enhance code block readability with syntax highlighting.

Documentation:

  • Correct the repository name in the README from 'ollama-util' to 'ollamautil'.
  • Add 'sh' to code block tick-marks for syntax highlighting.

Correct repository is `ollamautil`; not `ollama-util`.

Signed-off-by: Tammy DiPrima <[email protected]>
Copy link

sourcery-ai bot commented Dec 6, 2024

Reviewer's Guide by Sourcery

This PR updates the README.md file with minor formatting improvements and corrects the repository name from 'ollama-util' to 'ollamautil'. The changes include adding syntax highlighting for shell commands and ensuring consistent repository naming throughout the documentation.

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

File-Level Changes

Change Details Files
Updated repository naming for consistency
  • Changed repository name from 'ollama-util' to 'ollamautil' in clone URL
  • Updated virtual environment name to match repository name
  • Updated directory path references to use new name
README.md
Enhanced code block formatting
  • Added 'sh' language identifier to shell command code blocks
  • Improved spacing around code blocks for better readability
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 @tdiprima - 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.

Fixed my own oops.

Signed-off-by: Tammy DiPrima <[email protected]>
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