docs(@vben-core/preferences): update comments

[caodachen]

Description

Type of change

Please delete options that are not relevant.

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• This change requires a documentation update
• Please, don't make changes to pnpm-lock.yaml unless you introduce a new test example.

Checklist

ℹ️ Check all checkboxes - this will indicate that you have done everything in accordance with the rules in CONTRIBUTING.

• If you introduce new functionality, document it. You can run documentation with pnpm run docs:dev command.
• Run the tests with pnpm test.
• Changes in changelog are generated from PR name. Please, make sure that it explains your changes in an understandable manner. Please, prefix changeset messages with feat:, fix:, perf:, docs:, or chore:.
• My code follows the style guidelines of this project
• I have performed a self-review of my own code
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation
• My changes generate no new warnings
• I have added tests that prove my fix is effective or that my feature works
• New and existing unit tests pass locally with my changes
• Any dependent changes have been merged and published in downstream modules

Summary by CodeRabbit

• Documentation
  • Updated documentation reference for authentication panel layout configuration setting to accurately reflect the positioning reference.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[changeset-bot]

⚠️ No Changeset found

Latest commit: de77b54

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[coderabbitai]

📝 Walkthrough

Walkthrough

A documentation comment for the authPanelRight property in the preferences module was corrected to accurately reflect its purpose. The comment now correctly indicates "right side" instead of "left side" for the login registration page layout orientation.

Changes

Cohort / File(s)	Summary
Documentation Update packages/@core/preferences/src/use-preferences.ts	Corrected comment for authPanelRight property from describing left-side layout to right-side layout

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~1 minute

Suggested labels

documentation

Suggested reviewers

• anncwb
• vince292007

Poem

🐰 A comment was fixed with care so true,
Left became right in the reviewer's view,
Small tweak, big clarity—the layout's now clear,
Documentation blooms when corrections appear! 📝✨

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	Write docstrings for the functions missing them to satisfy the coverage threshold.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title accurately describes the main change: updating documentation comments in the preferences module.
Description check	✅ Passed	The PR description follows the template structure with Type of change and Checklist sections completed, though the Description section lacks detail about what specifically was changed.

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

✨ Finishing touches

• 📝 Generate docstrings

---

---

📜 Recent review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8a7e2bd and de77b54.

📒 Files selected for processing (1)

• packages/@core/preferences/src/use-preferences.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). (2)

• GitHub Check: post-update (windows-latest)
• GitHub Check: post-update (ubuntu-latest)

🔇 Additional comments (1)

packages/@core/preferences/src/use-preferences.ts (1)

139-139: LGTM! Documentation correction aligns with function behavior.

The comment now correctly indicates "right side" (右侧) instead of "left side" (左侧), which accurately matches the authPanelRight function name and its logic that checks for 'panel-right'.

_{✏️ Tip: You can disable this entire section by setting review_details to false in your review settings.}

---

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.}