[PR #4897] [MERGED] docs: delete incorrectly documented error case for baseURL #5645

Closed
opened 2026-03-13 12:30:19 -05:00 by GiteaMirror · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/better-auth/better-auth/pull/4897
Author: @JeffreyLind3
Created: 9/25/2025
Status: Merged
Merged: 9/25/2025
Merged by: @himself65

Base: canaryHead: docs/fix-base-url-docstring-in-options-ts


📝 Commits (1)

  • a26a50b docs: Delete incorrectly documented error case in baseURL in options.ts

📊 Changes

1 file changed (+0 additions, -2 deletions)

View changed files

📝 packages/better-auth/src/types/options.ts (+0 -2)

📄 Description

As conversed about in #4896, this deletes documentation discussing a non-existent error case when not utilizing baseURL AND not utilizing BETTER_AUTH_URL.


Summary by cubic

Removed an incorrect note in BetterAuth options.ts that claimed an error is thrown when both baseURL and BETTER_AUTH_URL are unset. The baseURL docs now reflect the actual behavior: it checks BETTER_AUTH_URL without throwing.


🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/better-auth/better-auth/pull/4897 **Author:** [@JeffreyLind3](https://github.com/JeffreyLind3) **Created:** 9/25/2025 **Status:** ✅ Merged **Merged:** 9/25/2025 **Merged by:** [@himself65](https://github.com/himself65) **Base:** `canary` ← **Head:** `docs/fix-base-url-docstring-in-options-ts` --- ### 📝 Commits (1) - [`a26a50b`](https://github.com/better-auth/better-auth/commit/a26a50b0b14b3a042015b0b6b1107fd0b6d38414) docs: Delete incorrectly documented error case in baseURL in options.ts ### 📊 Changes **1 file changed** (+0 additions, -2 deletions) <details> <summary>View changed files</summary> 📝 `packages/better-auth/src/types/options.ts` (+0 -2) </details> ### 📄 Description As conversed about in #4896, this deletes documentation discussing a non-existent error case when not utilizing baseURL AND not utilizing BETTER_AUTH_URL. <!-- This is an auto-generated description by cubic. --> --- ## Summary by cubic Removed an incorrect note in BetterAuth options.ts that claimed an error is thrown when both baseURL and BETTER_AUTH_URL are unset. The baseURL docs now reflect the actual behavior: it checks BETTER_AUTH_URL without throwing. <!-- End of auto-generated description by cubic. --> --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
GiteaMirror added the pull-request label 2026-03-13 12:30:19 -05:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: github-starred/better-auth#5645