Skip to content

docs: fix four typos in README code comments - #1187

Merged
Belphemur merged 1 commit into
Belphemur:developfrom
vaibhav8a:fix-readme-typos
Aug 24, 2026
Merged

docs: fix four typos in README code comments#1187
Belphemur merged 1 commit into
Belphemur:developfrom
vaibhav8a:fix-readme-typos

Conversation

@vaibhav8a

Copy link
Copy Markdown
Contributor

Four typo fixes in README.md, all inside example code comments:

Line Fix
124 // The data will be overridenoverridden
153 // In case you have an exterior change to the databsedatabase
370 // First instanciate Config classinstantiate
389 // instanciate databaseinstantiate

Comments only — no example code, API names, or output changed.

overriden -> overridden, databse -> database, instanciate -> instantiate (x2)
@coderabbitai

coderabbitai Bot commented Aug 24, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 909ccdf4-05c9-481b-85e3-44d9ab1d2ef0

📥 Commits

Reviewing files that changed from the base of the PR and between ec0748f and a4aefe1.

📒 Files selected for processing (1)
  • README.md

Included review availability: Your plan provides up to 4 included reviews per hour; 3 remain after this review.


📝 Walkthrough

Summary by CodeRabbit

  • Documentation
    • Corrected four spelling errors in the README for improved clarity and readability.

Walkthrough

The README contains four spelling corrections in comments. No exported or public declarations changed.

Changes

README corrections

Layer / File(s) Summary
Correct README comment spelling
README.md
Corrected “overriden” to “overridden,” “databse” to “database,” and two instances of “instanciate” to “instantiate.”

Estimated code review effort: 1 (Trivial) | ~2 minutes

Merge Risk: ⚪ Minimal · up to a4aef

This change only corrects spelling in README example comments without changing code, APIs, or outputs; no actionable merge-blocking risk remains after normal checks and review.

Poem

A rabbit checks the README with care,
Four tiny typos vanish from there.
“Overridden” now stands clear,
“Database” appears sincere.
“Instantiate” hops in twice—
Clean words make the page look nice!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely identifies the four README typo fixes.
Description check ✅ Passed The description accurately explains the four README comment typo corrections and their limited scope.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

Comment @coderabbitai help to get the list of available commands.

@codecov

codecov Bot commented Aug 24, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 99.66%. Comparing base (ec0748f) to head (a4aefe1).

Additional details and impacted files
@@            Coverage Diff            @@
##           develop    #1187    +/-   ##
=========================================
  Coverage    99.66%   99.66%            
=========================================
  Files           13       13            
  Lines         1770     1770            
  Branches       243      362   +119     
=========================================
  Hits          1764     1764            
  Misses           6        6            

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@Belphemur

Copy link
Copy Markdown
Owner

Hello,

Thank you for those fixed 😁

@Belphemur
Belphemur merged commit f8901eb into Belphemur:develop Aug 24, 2026
10 of 11 checks passed
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.

2 participants