docs: add doc style tips to HACKING.md #556
Merged
Conversation
This file contains 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
|
I agree with all the items. Just one comment: Maybe each bullet point in the list should end with a period? They are all full sentences after all; also to be consistent with other lists in the same doc. |
IronCore864
approved these changes
Jan 15, 2025
|
Good call @IronCore864, thanks! (I have a bit of a habit of leaving periods off...) |
benhoyt
approved these changes
Jan 15, 2025
dwilding
added a commit
to canonical/operator
that referenced
this pull request
Jan 16, 2025
This PR adds a few style tips to the Documentation section of HACKING.md (the same ones we added to Pebble in canonical/pebble#556).
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.
This PR adds a few style tips to the Docs section of HACKING.md. I've tried to keep the list short and (hopefully!) memorable