Repository navigation
docs(pat): fix style findings in the authentication guide - #380
Draft
mknell-godaddy wants to merge 1 commit into
Draft
mknell-godaddy wants to merge 1 commit into
mknell-godaddy wants to merge 1 commit into
Conversation
Why: the guide style rules report 32 findings in auth.md. A later change makes
the check blocking, so each guide has to pass first. This is the third guide,
after shopping and DNS, and it is split out so the PAT reviewers see only
their own text.
What changed: wording only, each edit keeping its meaning. Em dashes became
colons or periods, "via" became "with", "e.g." became "for example", and
"CI/CD" became "CICD". Spelled-out "do not", "does not", "is not" and "have
not" became contractions, and the three "does not" sentences that bolded the
word keep the emphasis on the contraction. Two sentences over 30 words are
split, "Once you have logged in" became "After you log in", and two passive
phrases are active. Headings use the imperative ("Create a PAT", "Store a PAT
in the CLI", "List and remove PATs", "Use PATs in CI"), including two the
rule's gerund list doesn't match, so the guide reads the same throughout.
The only in-guide anchor link points to "How the CLI chooses a credential",
which is unchanged. No Rust files change and no test reads this guide's text.
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
No active review issues remain for the authentication guide’s style-focused revisions.
No open issues 🎉
What changed in this PR
Updates the authentication guide to align with the planned guide style rules, without changing CLI behavior or authentication instructions.
Changes:
- Simplifies wording, punctuation, and long sentences.
- Uses imperative headings for PAT tasks.
- Applies contractions and the deliberate “CICD” spelling consistently.
| File | Description |
|---|---|
rust/src/pat/guides/auth.md |
Revises OAuth and PAT documentation for guide style compliance. |
Review effort: Balanced
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.
Why
The new guide style rules report 32 findings in
auth.md. A later change makes the check blocking, so each guide has to pass first. This is the third guide, after shopping (#376) and DNS (#377), split out so the PAT reviewers see only their own text.What changed
Wording edits in
rust/src/pat/guides/auth.md. Each keeps its meaning.For reviewers
gddystores"). The meaning is the same.Checked
auth.mdhas no findings.docsand the README for the old headings and found no links.cargo testlocally, so the test run here is CI's.The rules are in #375, which isn't merged yet. This change doesn't depend on them.