doc: edits for consistency, style guide alignment#1325
Merged
Conversation
2 tasks
roosterfish
previously approved these changes
Apr 13, 2026
Contributor
|
Needs a rebase. |
This commit brings docs into alignment with inclusive language standards by replacing "see" (for example, "see <cross reference>") with alternatives such as "refer to", "visit", and "consult". It also seeks to ensure consistency in punctuation by removing colons when cross references appear mid-sentence. For example: "Refer to: <cross reference> for details." becomes "Refer to <cross reference> for details." Signed-off-by: Elijah Greenstein <elijah.greenstein@canonical.com>
Change "e.g." to "for example". Signed-off-by: Elijah Greenstein <elijah.greenstein@canonical.com>
elijahgreenstein
dismissed stale reviews from roosterfish and minaelee
via
c3199b9
elijahgreenstein
force-pushed
the
style-guide
branch
from
e2e404c to
c3199b9
Compare
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
3 participants
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 includes edits intended to bring the documentation into alignment with inclusive language and style guide standards:
see <cross reference>) with alternatives such as "refer to", "consult", and "visit."This PR also aims for consistency in punctuation by removing colons that precede in-line cross references (for example,
Refer to: <ref> for detailsbecomesRefer to <ref> for details).Checklist