docs: Fix `reload` option typo #11601

radovanovic-stevan · 2025-08-16T09:38:14Z

Description of change

Just a small typo I've noticed while using TypeORM recently. Fixed it in two places.

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
- Corrected grammar in the SaveOptions reload option description, using “do not” for databases without RETURNING/OUTPUT support.
- Aligned wording between user documentation and inline API comments for consistency and readability.
- Clarifies the description without altering behavior or APIs, ensuring clearer guidance when working with repositories and save operations.

coderabbitai · 2025-08-16T09:38:22Z

Walkthrough

Documentation grammar corrections in one docs page and one TypeScript JSDoc comment. No functional, behavioral, API, or control-flow changes.

Changes

Cohort / File(s)	Summary of Changes
Docs grammar fix `docs/docs/working-with-entity-manager/6-repository-api.md`	Corrected phrasing: “does not support” → “do not support” in SaveOptions reload description.
JSDoc grammar fix `src/repository/SaveOptions.ts`	Updated JSDoc text to use “do not support” regarding databases without RETURNING/OUTPUT.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

A rabbit tapped its docs with care,
Tweaked a verb to make it fair.
“Do not,” it wrote, with tidy paws—
Grammar carrots, crispy laws.
Now comments, docs, all neatly suit—
Hop, approve, and onward scoot! 🥕🐇

Tip

🔌 Remote MCP (Model Context Protocol) integration is now available!

Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats.

✨ Finishing Touches

📝 Generate Docstrings

🧪 Generate unit tests

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

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

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

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Status, Documentation and Community

Visit our Status Page to check the current availability of CodeRabbit.
Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (2)

src/repository/SaveOptions.ts (1)
35-35: Optional wording polish for clarity and precision.

Consider using "that" and referring to RETURNING/OUTPUT as a clause for accuracy.
- * It will work only on databases which do not support RETURNING / OUTPUT statement.
+ * This option has effect only on databases that do not support the RETURNING / OUTPUT clause.
docs/docs/working-with-entity-manager/6-repository-api.md (1)
458-458: Optional phrasing improvement to mirror SQL terminology.

Using "clause" is more precise than "statement" here.
- -   `reload`: boolean - Flag to determine whether the entity that is being persisted should be reloaded during the persistence operation. It will work only on databases which do not support RETURNING / OUTPUT statement. Enabled by default.
+ -   `reload`: boolean - Flag to determine whether the entity that is being persisted should be reloaded during the persistence operation. This option has effect only on databases that do not support the RETURNING / OUTPUT clause. Enabled by default.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

💡 Knowledge Base configuration:

MCP integration is disabled by default for public repositories
Jira integration is disabled
Linear integration is disabled

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 0b767e8 and 13cd954.

📒 Files selected for processing (2)

docs/docs/working-with-entity-manager/6-repository-api.md (1 hunks)
src/repository/SaveOptions.ts (1 hunks)

🔇 Additional comments (2)

src/repository/SaveOptions.ts (1)

35-35: LGTM — corrected subject–verb agreement.

The JSDoc fix is correct and aligns with the docs update.

docs/docs/working-with-entity-manager/6-repository-api.md (1)

458-458: LGTM — grammar fix is consistent with code comments.

The updated phrasing matches the SaveOptions.ts JSDoc and reads correctly.

gioboa

Thanks for your help @radovanovic-stevan
Kudos for your first PR in this project 🎉👏

pkg-pr-new · 2025-08-16T12:34:40Z

typeorm-sql-js-example

npm i https://pkg.pr.new/typeorm/typeorm@11601

commit: 13cd954

coveralls · 2025-08-16T13:00:37Z

coverage: 76.353%. remained the same
when pulling 13cd954 on radovanovic-stevan:docs-reload-fix-typo
into 0b767e8 on typeorm:master.

docs: Fix reload option typo

13cd954

coderabbitai bot reviewed Aug 16, 2025

View reviewed changes

alumni approved these changes Aug 16, 2025

View reviewed changes

gioboa approved these changes Aug 16, 2025

View reviewed changes

gioboa merged commit 1698313 into typeorm:master Aug 16, 2025
58 checks passed

ThbltLmr pushed a commit to ThbltLmr/typeorm that referenced this pull request Dec 2, 2025

docs: fix reload option typo (typeorm#11601)

e97d627

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

docs: Fix `reload` option typo #11601

docs: Fix `reload` option typo #11601

Uh oh!

radovanovic-stevan commented Aug 16, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Aug 16, 2025 •

edited

Loading

Chat

Support

CodeRabbit Commands (Invoked using PR/Issue comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Status, Documentation and Community

Uh oh!

coderabbitai bot left a comment

Uh oh!

gioboa left a comment

Uh oh!

pkg-pr-new bot commented Aug 16, 2025

Uh oh!

coveralls commented Aug 16, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Uh oh!

docs: Fix reload option typo #11601

docs: Fix reload option typo #11601

Uh oh!

Conversation

radovanovic-stevan commented Aug 16, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description of change

Pull-Request Checklist

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Aug 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Poem

Chat

Support

CodeRabbit Commands (Invoked using PR/Issue comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Status, Documentation and Community

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

gioboa left a comment

Choose a reason for hiding this comment

Uh oh!

pkg-pr-new bot commented Aug 16, 2025

Uh oh!

coveralls commented Aug 16, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

docs: Fix `reload` option typo #11601

docs: Fix `reload` option typo #11601

radovanovic-stevan commented Aug 16, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Aug 16, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)