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 #557

Merged
merged 4 commits into from
Nov 18, 2024
Merged

feat: add documentation link in help messages #557

merged 4 commits into from
Nov 18, 2024

Conversation

mr-cal
Copy link
Contributor

@mr-cal mr-cal commented Nov 15, 2024

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

Adds documentation links in general help messages and command help messages.

lengau
lengau approved these changes Nov 15, 2024
View reviewed changes
Copy link
Contributor

@lengau lengau left a comment

Choose a reason for hiding this comment

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

LGTM, though we should probably use an RFC 2606 domain rather than craft-app.com (which is owned by someone other than Canonical).

tests/integration/test_application.py Outdated Show resolved Hide resolved
tests/integration/test_application.py Outdated Show resolved Hide resolved
tests/unit/test_application.py Outdated Show resolved Hide resolved
tests/unit/test_application.py Outdated Show resolved Hide resolved
@lengau
Copy link
Contributor

lengau commented Nov 15, 2024

Also I know the linter breakage is unrelated, but since an autoformat would fix it I think it's ok to include here :-)

@mr-cal
Copy link
Contributor Author

mr-cal commented Nov 15, 2024

Also I know the linter breakage is unrelated, but since an autoformat would fix it I think it's ok to include here :-)

Interesting bug: astral-sh/ruff#14228

@mr-cal mr-cal requested a review from a team November 15, 2024 15:36
@dariuszd21
Copy link
Contributor

Also I know the linter breakage is unrelated, but since an autoformat would fix it I think it's ok to include here :-)

Interesting bug: astral-sh/ruff#14228

I used - instead of # as I found that it was somewhere in the codebase already

@mr-cal mr-cal merged commit 3ed44e1 into main Nov 18, 2024
9 of 10 checks passed
@mr-cal mr-cal deleted the work/url-in-help branch November 18, 2024 13:48
linostar pushed a commit to linostar/craft-application that referenced this pull request Dec 4, 2024
@mr-cal
feat: add documentation link in help messages (canonical#557)
d6aba6b 
Signed-off-by: Callahan Kovacs <[email protected]>
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

@lengau lengau lengau approved these changes

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 @lengau @dariuszd21