docs: provide examples in unit testing how-to, and other small improvements#2251
Merged
dwilding merged 5 commits intocanonical:mainfrom Dec 19, 2025
Merged
docs: provide examples in unit testing how-to, and other small improvements#2251dwilding merged 5 commits intocanonical:mainfrom
dwilding merged 5 commits intocanonical:mainfrom
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR enhances the unit testing how-to documentation by adding examples and improving consistency with the integration testing guide. The changes make the documentation more actionable and user-friendly.
Key changes:
- Added an "Examples" section with links to unit tests for both machine and Kubernetes charms
- Added a "Run your tests" section explaining how to execute tests using
tox -e unit - Standardized section headings to use imperative mood (e.g., "Set up" instead of "Setting up")
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Contributor
Author
|
Should be a quick review, but can wait until January |
james-garner-canonical
approved these changes
Dec 19, 2025
dimaqq
approved these changes
Dec 19, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #2147. The main changes in this PR are:
tox -e unit, making the unit testing how-to consistent with the integration testing how-to.Preview doc