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

Cleanup READMEs and man pages. #780

Merged
merged 1 commit into from
Feb 10, 2025
Merged

Cleanup READMEs and man pages. #780

merged 1 commit into from
Feb 10, 2025

Conversation

rhatdan
Copy link
Member

@rhatdan rhatdan commented Feb 10, 2025

Summary by Sourcery

Documentation:

  • Clarify help texts and re-order commands in the documentation.

Signed-off-by: Daniel J Walsh <[email protected]>
Copy link
Contributor

sourcery-ai bot commented Feb 10, 2025

Reviewer's Guide by Sourcery

This pull request focuses on cleaning up the documentation and command-line interface help texts for consistency and accuracy. The updates include reordering command entries, standardizing casing in descriptions, and removing duplicate entries from both the man pages and README file. Additionally, the CLI argument parser's invocation order was adjusted for improved usability.

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

File-Level Changes

Change Details Files
Updated manual pages for consistent formatting and command ordering
  • Standardized text capitalization (e.g., changed 'Display' to 'display') in command descriptions
  • Reordered entries in the man page tables and removed duplicate perplexity command entry
docs/ramalama.1.md
docs/ramalama-info.1.md
Adjusted CLI parser configuration in the application
  • Moved the help_parser call to ensure proper ordering of subcommands
  • Updated the help text for the 'info' command to use lower-case 'display' for consistency
  • Modified the help_parser to remove the explicit help string, relying on default behavior
ramalama/cli.py
Cleaned up README command table entries
  • Reordered command entries to reflect the correct and updated command list
  • Added entries for commands like 'ramalama-bench', 'ramalama-inspect', and 'ramalama-perplexity'
  • Removed duplicate entry for 'ramalama-convert'
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

Copy link
Contributor

@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 @rhatdan - I've reviewed your changes - here's some feedback:

Overall Comments:

  • It looks like you're reordering some commands in the tables - can you confirm the ordering you're using?
  • The help parser should have a help string, even if it's just a placeholder.
Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟢 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.

| [ramalama-info(1)](https://github.com/containers/ramalama/blob/main/docs/ramalama-info.1.md) | display RamaLama configuration information |
| [ramalama-inspect(1)](https://github.com/containers/ramalama/blob/main/docs/ramalama-inspect.1.md) | display RamaLama configuration information |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

issue (bug_risk): The description for ramalama-inspect seems incorrect (same as ramalama-info).

@rhatdan rhatdan merged commit ba2d283 into containers:main Feb 10, 2025
16 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.

2 participants