docs(core): fix grammar and parallelism

[isagi-y22]

No description provided.

[coderabbitai]

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

Documentation updates in three README files clarify ERC20 examples to use spread of defaults combined with upgradeability. Text changes replace “but” with “and,” and code snippets now show {...erc20.defaults, upgradeable: true/'uups'}. No source code or public APIs changed.

Changes

Cohort / File(s)	Summary
README ERC20 example updates packages/core/cairo/README.md, packages/core/cairo_alpha/README.md, packages/core/solidity/README.md	Adjusted phrasing to “defaults and is upgradeable”; updated code examples to use spread of defaults with upgradeable flag ({...erc20.defaults, upgradeable: true} or 'uups'). No functional or API changes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Suggested labels

ignore-changeset

Suggested reviewers

• ericglau
• CoveMB

Pre-merge checks and finishing touches

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Description Check	❓ Inconclusive	No pull request description was provided, so there is insufficient information in the PR description itself to verify intent beyond the title and file summaries, making this check inconclusive.	Please add a short description summarizing the change (e.g., doc wording and example updates across core READMEs, no functional changes) and any notes for reviewers to make the PR self-contained and easier to review.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Title Check	✅ Passed	The title "docs(core): fix grammar and parallelism" is a concise, conventional-commit style summary that accurately reflects the primary change (documentation wording and example updates across core package READMEs) and is directly related to the provided file summaries.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 3

🧹 Nitpick comments (3)

packages/core/solidity/README.md (1)

128-132: Optional: simplify example by omitting the defaults spread.

print applies defaults when options are omitted, so the spread is redundant here.

-const contract = erc20.print({
-  ...erc20.defaults,
-  upgradeable: 'uups',
-});
+const contract = erc20.print({ upgradeable: 'uups' });

packages/core/cairo/README.md (1)

138-142: Optional: simplify example by omitting the defaults spread.

Defaults are applied automatically by print.

-const contract = erc20.print({
-  ...erc20.defaults,
-  upgradeable: true,
-});
+const contract = erc20.print({ upgradeable: true });

packages/core/cairo_alpha/README.md (1)

142-146: Optional: simplify example by omitting the defaults spread.

Defaults are implied.

-const contract = erc20.print({
-  ...erc20.defaults,
-  upgradeable: true,
-});
+const contract = erc20.print({ upgradeable: true });

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 11bf759 and 6afd60d.

📒 Files selected for processing (3)

• packages/core/cairo/README.md (1 hunks)
• packages/core/cairo_alpha/README.md (1 hunks)
• packages/core/solidity/README.md (1 hunks)

🧰 Additional context used

🧠 Learnings (4)

📚 Learning: 2025-08-19T15:21:06.991Z

Learnt from: ericglau
PR: OpenZeppelin/contracts-wizard#638
File: packages/core/cairo_alpha/src/account.test.ts.md:18-18
Timestamp: 2025-08-19T15:21:06.991Z
Learning: In the OpenZeppelin contracts-wizard repository, the cairo_alpha package (packages/core/cairo_alpha) and the stable cairo package (packages/core/cairo) are separate implementations that do not need to have the same code or matching dependency versions. The cairo_alpha package targets dependencies that are either newer than or the same as the stable cairo package, allowing it to test and support newer Cairo/Scarb/OpenZeppelin versions while the stable version maintains compatibility with stable releases.

Applied to files:

• packages/core/cairo/README.md
• packages/core/cairo_alpha/README.md

📚 Learning: 2025-08-19T15:31:24.984Z

Learnt from: ericglau
PR: OpenZeppelin/contracts-wizard#0
File: :0-0
Timestamp: 2025-08-19T15:31:24.984Z
Learning: Changes within packages/core/cairo_alpha should have a corresponding changelog entry in packages/core/cairo_alpha/CHANGELOG.md under the Unreleased section to track these changes. When cairo_alpha is eventually promoted to cairo (stable), these entries will be moved into a changeset for cairo (stable).

Applied to files:

• packages/core/cairo/README.md
• packages/core/cairo_alpha/README.md

📚 Learning: 2025-08-19T15:18:09.410Z

Learnt from: ericglau
PR: OpenZeppelin/contracts-wizard#638
File: packages/core/cairo_alpha/src/scripts/update-scarb-project.ts:62-79
Timestamp: 2025-08-19T15:18:09.410Z
Learning: In the cairo_alpha package (packages/core/cairo_alpha), the OpenZeppelin dependency in test_project/Scarb.toml is expected to be in { git, tag } form rather than a simple registry-style string, so the update script only needs to update the tag value, not convert between formats.

Applied to files:

• packages/core/cairo/README.md
• packages/core/cairo_alpha/README.md

📚 Learning: 2025-09-12T15:07:08.673Z

Learnt from: ericglau
PR: OpenZeppelin/contracts-wizard#663
File: packages/core/cairo_alpha/src/custom.test.ts.md:12-12
Timestamp: 2025-09-12T15:07:08.673Z
Learning: In the OpenZeppelin contracts-wizard cairo_alpha package changelog (packages/core/cairo_alpha/CHANGELOG.md), each alpha version gets its own separate entry under the "Unreleased" section rather than updating a single entry. This allows tracking of changes across different alpha releases (e.g., v3.0.0-alpha.0, v3.0.0-alpha.1, v3.0.0-alpha.2 all have separate entries).

Applied to files:

• packages/core/cairo/README.md
• packages/core/cairo_alpha/README.md

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)

• GitHub Check: validate-cairo
• GitHub Check: validate-cairo-alpha
• GitHub Check: build (solidity, default)
• GitHub Check: semgrep-cloud-platform/scan

[ericglau]

Thanks for the PR but I don't find this necessary. The previous grammar with "but" is correct because the example shows how to change one of the fields from the defaults.