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: Documentation/help inconsistency. #10173

Merged
merged 1 commit into from
Feb 12, 2025

Conversation

guillermodotn
Copy link
Contributor

@guillermodotn guillermodotn commented Feb 11, 2025

Pull Request Check List

Resolves: #6887

  • [ N/A ] Added tests for changed code.
  • [ N/A ] Updated documentation for changed code.

Description

Ensure that the documentation examples match those printed by the --help command.

Summary by Sourcery

Correct the help examples for the add command to accurately reflect the supported URL formats.

Enhancements:

  • Standardise URL formats in the documentation and help output.

Documentation:

  • Update documentation examples to align with the corrected help output.

Copy link

sourcery-ai bot commented Feb 11, 2025

Reviewer's Guide by Sourcery

The pull request updates the documentation examples shown by the --help command to ensure consistency. Specifically, the examples for git SSH URLs have been revised.

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

File-Level Changes

Change Details Files
Updated the git SSH URL format in documentation examples to match the output of the --help command.
  • Replaced the git SSH URL format from 'git+ssh://github.com/...' to 'git+ssh://[email protected]/...' for improved accuracy.
  • Ensured the format change is applied consistently within the documentation examples.
src/poetry/console/commands/add.py

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

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

Overall Comments:

  • It looks like you're standardizing the git SSH URL format; ensure this change doesn't affect existing configurations or scripts that might rely on the previous format.
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.

@radoering radoering enabled auto-merge (squash) February 12, 2025 11:56
@radoering radoering merged commit 3986d76 into python-poetry:main Feb 12, 2025
53 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.

Poetry add help discrepancy
2 participants