docs: fix grammar

[ralme1da]

• Fix incorrect article usage: "an Fungible" → "a Fungible" in Stellar docs

[github-actions]

All contributors have signed the CLA ✍️ ✅
_{Posted by the CLA Assistant Lite bot.}

[coderabbitai]

Walkthrough

Minor documentation and grammar corrections in the Stellar package. README.md fixes grammar in example text, and fungible.ts updates function docstrings without altering logic or behavior.

Changes

Cohort / File(s)	Summary
Documentation & Grammar Fixes packages/core/stellar/README.md	Grammar corrections: "an Fungible" → "a Fungible" in two example sentences
Comment & Docstring Updates packages/core/stellar/src/fungible.ts	Updated function docblock and surrounding comments; added explicit @returns description to getInitialSupply function without changing signature or behavior

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

• No logic, API, or control flow changes
• All modifications are cosmetic (grammar, documentation, comments)
• Functionally identical code samples

Suggested labels

ignore-changeset

Suggested reviewers

• ericglau
• CoveMB

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	You can run @coderabbitai generate docstrings to improve docstring coverage.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title 'docs: fix grammar' accurately describes the main change in the pull request, which involves grammar corrections in documentation.
Description check	✅ Passed	The description directly relates to the changeset by explaining the specific grammar fix being made: correcting 'an Fungible' to 'a Fungible' in Stellar docs.

✨ Finishing touches

• 📝 Generate docstrings

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

---

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: 0

🧹 Nitpick comments (1)

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

41-41: Grammar corrections look good, but consider conciseness.

The article corrections from "an Fungible" to "a Fungible" are correct. However, static analysis suggests removing "of" from "all of the default settings" to read "all the default settings" or simply "all default settings" for better conciseness.

- To generate the source code for a Fungible contract with all of the default settings:
+ To generate the source code for a Fungible contract with all the default settings:

- To generate the source code for a Fungible contract with some custom settings:
+ To generate the source code for a Fungible contract with some custom settings:

(The second change is already correct; the first could be further improved.)

Also applies to: 46-46

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ce8fbba and c1ce387.

📒 Files selected for processing (2)

• packages/core/stellar/README.md (1 hunks)
• packages/core/stellar/src/fungible.ts (1 hunks)

🧰 Additional context used

🧠 Learnings (1)

📚 Learning: 2025-09-19T14:28:19.048Z

Learnt from: ericglau
Repo: OpenZeppelin/contracts-wizard PR: 652
File: packages/core/confidential/src/zip-hardhat.test.ts.md:116-121
Timestamp: 2025-09-19T14:28:19.048Z
Learning: In OpenZeppelin Confidential Contracts, the decimals() function is limited to 6, not the typical 18 decimals found in standard ERC20 tokens. This affects overflow calculations when working with premint amounts and SafeCast.toUint64().

Applied to files:

• packages/core/stellar/src/fungible.ts

🪛 LanguageTool

packages/core/stellar/README.md

[style] ~41-~41: Consider removing “of” to be more concise
Context: ...ource code for a Fungible contract with all of the default settings: ```js const contract ...

(ALL_OF_THE)

🔇 Additional comments (2)

packages/core/stellar/src/fungible.ts (2)

180-180: Comment is clear and helpful.

The updated comment on line 180 accurately describes the operation and improves code documentation.

---

206-206: JSDoc improvement: explicit @returns documentation.

Adding an explicit @returns description (line 211) is a best practice that improves API documentation completeness. The description accurately reflects the function's return behavior.

Also applies to: 211-211

[ralme1da]

I confirm that I have read and hereby agree to the OpenZeppelin Contributor License Agreement