-
Notifications
You must be signed in to change notification settings - Fork 2.3k
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
Conversation
Reviewer's Guide by SourceryThe 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
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this 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
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
Pull Request Check List
Resolves: #6887
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:
Documentation: