Repository navigation
docs(shopping): fix style findings in the shopping guide - #376
Merged
Merged
Conversation
Why: the guide style rules report 10 findings in shopping.md: "such as", "currently", "appears", an unspaced em dash, four spelled-out contractions, and a 34-word sentence. The next change makes the check blocking, so the guide has to pass first. What changed: seven wording edits, each keeping its meaning. "such as" became "for example". "currently" was dropped. The em dash became a period. "they are", "is not" and "appears" became "they're", "isn't" and "it's available". The billing address sentence is split in two, so the field list stands alone. What was left alone: the "AI assistants:" paragraph. Tests in other files pin its exact wording, and the same text sits in a Rust constant that agents read. The style check skips paragraphs of that shape. No Rust files change.
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
The shopping-guide wording changes have no active review issues.
No open issues 🎉
What changed in this PR
Updates the shopping guide to address the style findings from #375 without changing CLI behavior or the purchase-consent instructions for AI assistants.
Changes:
- Simplifies wording and uses contractions.
- Replaces an em dash with a sentence break and splits the billing-address explanation.
- Clarifies the wording for waiting until an order is available.
| File | Description |
|---|---|
rust/src/shopping/guides/shopping.md |
Makes seven wording edits to align the shopping guide with the proposed style rules. |
Review effort: Balanced
mknell-godaddy
marked this pull request as ready for review
November 16, 2026 20:45
mknell-godaddy
requested review from
axburgess-godaddy,
jpage-godaddy,
jpearlman-godaddy,
mguerrero3-godaddy,
qcai-godaddy,
rts1-godaddy and
sswaminathan-godaddy
as code owners
November 16, 2026 20:45
This was referenced Nov 16, 2026
jpage-godaddy
approved these changes
Nov 16, 2026
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 10 findings in
shopping.md. A later change makes the check blocking, so each guide has to pass first. This is the first guide, split out so the shopping reviewers see only their own text.What changed
Seven wording edits in
rust/src/shopping/guides/shopping.md. Each keeps its meaning.What was left alone
The "AI assistants:" paragraph is unchanged. Tests in other files check its exact wording, and the same text is a Rust constant that agents read. Changing "Do not" to "Don't" would mean changing tests in several files. The style check skips paragraphs that start with "AI assistants:".
Checked
shopping.mdhas no findings.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.