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.

Sign up for GitHub

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

Jump to bottom

feat: add documentation link in help messages #298

Merged
merged 4 commits into from
Oct 31, 2024
Merged

feat: add documentation link in help messages #298

merged 4 commits into from
Oct 31, 2024

Conversation

mr-cal
Copy link
Contributor

@mr-cal mr-cal commented Oct 30, 2024 •
edited
Loading

  • Have you followed the guidelines for contributing?
  • Have you signed the CLA?
  • Have you successfully run tox?

Adds a documentation link to the bottom of general help and a command-specific link to command help messages.

I did not add a URL link to the markdown format of command help.

@mr-cal
feat: add documentation link in help messages
3c5ff52 
Signed-off-by: Callahan Kovacs <callahankovacs@gmail.com>
@tigarmo tigarmo requested review from tigarmo and lengau October 31, 2024 10:46
@mr-cal mr-cal requested a review from dariuszd21 October 31, 2024 10:47
@mr-cal
docs(changelog): add 2.10.0 release notes
b8df1c2 
Signed-off-by: Callahan Kovacs <callahankovacs@gmail.com>
tigarmo
tigarmo reviewed Oct 31, 2024
View reviewed changes
docs/changelog.rst Outdated Show resolved Hide resolved
@mr-cal @tigarmo
Update docs/changelog.rst
ce88a60 
Co-authored-by: Tiago Nobrega <tiago.nobrega@canonical.com>
dariuszd21
dariuszd21 approved these changes Oct 31, 2024
View reviewed changes
Copy link
Contributor

@dariuszd21 dariuszd21 left a comment

Choose a reason for hiding this comment

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

Thank you! I've left some minor comments, but they're definitely not blocking

craft_cli/helptexts.py Show resolved Hide resolved
craft_cli/helptexts.py Outdated Show resolved Hide resolved
tests/unit/test_help.py Show resolved Hide resolved
@mr-cal
chore: feedback from PR
3425801 
Signed-off-by: Callahan Kovacs <callahankovacs@gmail.com>
@tigarmo tigarmo merged commit 1b59990 into main Oct 31, 2024
12 checks passed
@tigarmo tigarmo deleted the work/url-in-help branch October 31, 2024 15:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dariuszd21 dariuszd21 dariuszd21 approved these changes

@tigarmo tigarmo tigarmo approved these changes

@lengau lengau Awaiting requested review from lengau

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@mr-cal @tigarmo @dariuszd21