Skip to content

Fix typos in documentation / hacktoberfest #11713

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
naorpeled merged 3 commits into from
Oct 20, 2025
Merged

Fix typos in documentation / hacktoberfest #11713

naorpeled merged 3 commits into from
Oct 20, 2025
+25 −25

Conversation

@survivant
Copy link
Contributor

@survivant survivant commented Oct 5, 2025 •
edited by coderabbitai bot
Loading

Description of change

Just little typos in the documentation

Pull-Request Checklist

  • Code is up-to-date with the master branch
  • This pull request links relevant issues as Fixes #00000
  • There are new or updated unit tests validating the change
  • Documentation has been updated to reflect this change

Summary by CodeRabbit

  • Documentation
    • Fixed grammar and article usage across advanced topics (migrations, indices, listeners/subscribers, decorator reference).
    • Standardized capitalization and terminology (TypeORM, Postgres, ACCESS EXCLUSIVE).
    • Improved clarity and readability with refined phrasing, punctuation, and inline formatting (e.g., decorator references).
    • Enhanced Query Runner docs: clearer connection pool wording, lifecycle notes, and examples with consistent capitalization.
    • No functional or behavioral changes.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 5, 2025 •
edited
Loading

Walkthrough

Documentation edits across advanced topics, help, and query runner pages: grammar, capitalization, punctuation, and phrasing adjustments. No code, API, behavior, or control-flow changes.

Changes

Cohort / File(s) Summary
Advanced Topics — Migrations
docs/docs/advanced-topics/1-migrations.md		 Article/grammar fixes in constraint operation descriptions; text-only updates.
Advanced Topics — Indices
docs/docs/advanced-topics/3-indices.md		 Editorial copyedits: capitalization (e.g., TypeORM, Postgres), phrasing, punctuation; no functional content changes.
Advanced Topics — Listeners & Subscribers
docs/docs/advanced-topics/4-listeners-and-subscribers.md		 Grammar fix: “a entity” → “an entity” in multiple sections; documentation only.
Help — Decorator Reference
docs/docs/help/3-decorator-reference.md		 Grammar corrections for article usage around remove/soft-remove/recover descriptions.
Query Runner Docs
docs/docs/query-runner.md		 Minor grammatical/stylistic updates, capitalization standardization, clarified notes/examples; no behavior changes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Suggested reviewers

  • gioboa
  • naorpeled
  • OSA413

Poem

I twitch my nose at commas neat,
Hop through docs with tidy feet.
Articles aligned, capitals bright,
Burrows of text now read just right.
With every hop, a clearer view—
Carrots, code, and grammar too! 🥕✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check ✅ Passed The title succinctly conveys the primary change—fixing typos in documentation—even though it includes an ancillary “/ hacktoberfest” suffix that does not detract from understanding the main focus. The extra reference is not directly relevant to the content changes.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 2671579 and 7fe68a1.

📒 Files selected for processing (5)
  • docs/docs/advanced-topics/1-migrations.md (4 hunks)
  • docs/docs/advanced-topics/3-indices.md (3 hunks)
  • docs/docs/advanced-topics/4-listeners-and-subscribers.md (3 hunks)
  • docs/docs/help/3-decorator-reference.md (3 hunks)
  • docs/docs/query-runner.md (2 hunks)

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 and usage tips.

gioboa
gioboa approved these changes Oct 5, 2025
View reviewed changes
Copy link
Collaborator

@gioboa gioboa left a comment

Choose a reason for hiding this comment

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

Thanks for your help @survivant

@survivant
Copy link
Contributor Author

survivant commented Oct 6, 2025

if you want can you add this label to this PR : hacktoberfest-accepted

@naorpeled naorpeled added the hacktoberfest-accepted label hacktoberfest label Oct 20, 2025
@naorpeled naorpeled merged commit 8692da2 into typeorm:master Oct 20, 2025
1 check passed
@naorpeled
Copy link
Member

naorpeled commented Oct 20, 2025

Hey @survivant
thanks for this 🙏

@pkuczynski pkuczynski mentioned this pull request Nov 9, 2025
Merged
4 tasks
ThbltLmr pushed a commit to ThbltLmr/typeorm that referenced this pull request Dec 2, 2025
@survivant @ThbltLmr
docs: fix typos in documentation (typeorm#11713)
4cfcefe
mgohin pushed a commit to mgohin/typeorm that referenced this pull request Jan 15, 2026
@survivant
docs: fix typos in documentation (typeorm#11713)
8834f7b
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@pkuczynski pkuczynski pkuczynski approved these changes

@naorpeled naorpeled naorpeled approved these changes

@gioboa gioboa gioboa approved these changes

Assignees

No one assigned

Labels

documentation hacktoberfest-accepted label hacktoberfest

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@survivant @naorpeled @pkuczynski @gioboa