Skip to content

docs: updated jsdoc link to PostgreSQL documentation for data types #11680

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 3, 2025
Merged

docs: updated jsdoc link to PostgreSQL documentation for data types #11680

naorpeled merged 3 commits into from
Oct 3, 2025
+1 −2

Conversation

@pkuczynski
Copy link
Collaborator

@pkuczynski pkuczynski commented Sep 24, 2025 •
edited by coderabbitai bot
Loading

Description of change

Currently used link is quite outdated. I believe its better to point to the current version of PostgreSQL docs, which will be always moving with the newer releases.

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

    • Updated inline API documentation to reference the current official PostgreSQL data type docs, improving accuracy and clarity for developers.
    • Confirmed no changes to runtime behavior or public method signatures.

  • Chores

    • Routine maintenance to refresh external documentation links; no impact on user-facing functionality.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Sep 24, 2025 •
edited
Loading

Walkthrough

Updated a JSDoc link in PostgresDriver to reference the current PostgreSQL datatype documentation. No code logic, behavior, or public API changes were made.

Changes

Cohort / File(s) Summary
Docs / JSDoc update
src/driver/postgres/PostgresDriver.ts		 Replaced an outdated JSDoc reference with the current PostgreSQL datatype documentation URL; no runtime or control-flow modifications.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Suggested reviewers

  • alumni

Poem

I twitch my whiskers, update made,
A link refreshed, no code mislaid.
Docs now point where truth resides,
Small hop, quick check — the rabbit glides. 🐇

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 and accurately describes the core change of updating the JSDoc link to the current PostgreSQL documentation for data types, matching the changeset’s main purpose.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • 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 d143e35 and 4c32b0a.

📒 Files selected for processing (1)
  • src/driver/postgres/PostgresDriver.ts (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • src/driver/postgres/PostgresDriver.ts
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
  • GitHub Check: tests-windows / better-sqlite3
  • GitHub Check: tests-windows / sqlite
  • GitHub Check: Analyze (javascript-typescript)

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.

@pkg-pr-new
Copy link

pkg-pr-new bot commented Sep 24, 2025 •
edited
Loading

typeorm-sql-js-example

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

commit: 4c32b0a

gioboa
gioboa approved these changes Sep 24, 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, LGTM 👏

@coveralls
Copy link

coveralls commented Sep 25, 2025 •
edited
Loading

Coverage Status

coverage: 76.431%. remained the same
when pulling 4c32b0a on pkuczynski:docs/pg-link
into 925dee0 on typeorm:master.

@naorpeled naorpeled merged commit 77fb94d into typeorm:master Oct 3, 2025
62 checks passed
ThbltLmr pushed a commit to ThbltLmr/typeorm that referenced this pull request Dec 2, 2025
@pkuczynski @gioboa @ThbltLmr
docs: updated jsdoc link to PostgreSQL documentation for data types (t…
deccf4d 
…ypeorm#11680)

Co-authored-by: Giorgio Boa <35845425+gioboa@users.noreply.github.com>
mgohin pushed a commit to mgohin/typeorm that referenced this pull request Jan 15, 2026
@pkuczynski @gioboa
docs: updated jsdoc link to PostgreSQL documentation for data types (t…
6e93933 
…ypeorm#11680)

Co-authored-by: Giorgio Boa <35845425+gioboa@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@naorpeled naorpeled naorpeled approved these changes

@gioboa gioboa gioboa approved these changes

@alumni alumni Awaiting requested review from alumni

@jovanadjuric jovanadjuric Awaiting requested review from jovanadjuric

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@pkuczynski @coveralls @naorpeled @gioboa