Skip to content

docs: remove contradictory statement in Active Record/Data Mapper guide #11722

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
sgarner merged 1 commit into from
Oct 12, 2025
Merged

docs: remove contradictory statement in Active Record/Data Mapper guide #11722

sgarner merged 1 commit into from
Oct 12, 2025

Conversation

@ericmorand
Copy link
Contributor

@ericmorand ericmorand commented Oct 12, 2025 •
edited by coderabbitai bot
Loading

Closes #11715

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

Summary by CodeRabbit

  • Documentation
    • Updated the “Which one should I choose?” section in the Active Record vs. Data Mapper guide, removing a standalone sentence to streamline the conclusion.
    • Improved readability by tightening phrasing and reducing redundancy in the final paragraph.
    • No functional changes to the product; this update only affects written guidance visible in the documentation.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 12, 2025 •
edited
Loading

Walkthrough

A single documentation edit removes one sentence from the "Which one should I choose?" section in docs/guides. No code, APIs, or control flow are affected.

Changes

Cohort / File(s) Summary of changes
Docs wording cleanup
docs/docs/guides/1-active-record-data-mapper.md		 Removed a standalone sentence from the concluding paragraph of the guide section.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

I nibble words, a tidy hare,
Pluck one line with gentle care.
Docs now lighter, breezes flow—
Hop, snip, clarity in tow.
Ears up high, commit is done,
Fewer crumbs, the guide reads fun. 🐇✂️

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.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
Title Check ✅ Passed The title accurately and succinctly describes the primary change by indicating that a contradictory statement is being removed from the Active Record/Data Mapper guide documentation, and it clearly identifies the nature and location of the update without extraneous wording.
✨ 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

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

gioboa
gioboa approved these changes Oct 12, 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 @ericmorand

@gioboa gioboa requested a review from sgarner October 12, 2025 18:54
@sgarner sgarner changed the title Remove "And simplicity..." confusing paragraph in 1-active-record-data-mapper.md docs: remove contradictory statement in Active Record/Data Mapper guide Oct 12, 2025
@sgarner sgarner merged commit 7c55d32 into typeorm:master Oct 12, 2025
1 check passed
@sgarner
Copy link
Collaborator

sgarner commented Oct 12, 2025

Thanks for your contribution @ericmorand 💜

ThbltLmr pushed a commit to ThbltLmr/typeorm that referenced this pull request Dec 2, 2025
@ericmorand @ThbltLmr
Remove "...And simplicity..." confusing paragraph in 1-active-record-…
94a0b1d 
…data-mapper.md (typeorm#11722)

Closes typeorm#11715
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@sgarner sgarner sgarner approved these changes

@gioboa gioboa gioboa approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

"...and simplicity is always a key to better maintainability" is confusing

3 participants

@ericmorand @sgarner @gioboa