Skip to content

docs(shopping): fix style findings in the shopping guide - #376

Merged
jpage-godaddy merged 1 commit into
mainfrom
docs/shopping-guide-style
Nov 16, 2026
Merged

jpage-godaddy merged 1 commit into
mainfrom
docs/shopping-guide-style

Conversation

@mknell-godaddy

Copy link
Copy Markdown
Collaborator

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.

  • "such as" becomes "for example".
  • "currently supported" becomes "supported".
  • The em dash after "a preference" becomes a period.
  • "they are", "is not" and "appears" become "they're", "isn't" and "it's available".
  • The billing address sentence (34 words) is split in two, so the field list is its own sentence.

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

The rules are in #375, which isn't merged yet. This change doesn't depend on them.

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.
Copilot AI balanced review requested due to automatic review settings November 16, 2026 20:44

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 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

@jpage-godaddy
jpage-godaddy merged commit 2c578ca into main Nov 16, 2026
6 checks passed
@jpage-godaddy
jpage-godaddy deleted the docs/shopping-guide-style branch November 16, 2026 22:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants