docs: correct createBrowserHistory JSDoc option to parseLocation

[dfedoryshchev]

The createBrowserHistory JSDoc documents an opts.getHref parameter, but no such option exists on the function. The actual option is opts.parseLocation, which returns the current location as a HistoryLocation. Corrected the @param name and description to match the signature.

Summary by CodeRabbit

• Documentation
  • Updated documentation for browser history configuration options to clarify parameter naming conventions.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 79b59400-3a8b-4347-99b4-e8e1b4d33cf4

📥 Commits

Reviewing files that changed from the base of the PR and between ac821f4 and 46931a1.

📒 Files selected for processing (1)

• packages/history/src/index.ts

---

📝 Walkthrough

Walkthrough

A single JSDoc @param comment in createBrowserHistory is corrected: the documented option field name changes from opts.getHref to opts.parseLocation.

Changes

JSDoc Correction

Layer / File(s)	Summary
JSDoc param name correction packages/history/src/index.ts	@param text for createBrowserHistory options updated to reference opts.parseLocation instead of opts.getHref.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~1 minute

Poem

A name was wrong, a small misstep in time,
getHref had wandered past its prime.
parseLocation hops into its place,
The docs now match with bunny grace.
🐇✨

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly and specifically describes the main change: correcting JSDoc documentation for the createBrowserHistory function by renaming an incorrect parameter reference from getHref to parseLocation.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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