docs: sync documentation with current API (automated)#1639
Merged
Conversation
yogeshchoudhary147
approved these changes
Jul 5, 2026
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThis PR updates EXAMPLES.md documentation only: it adds a deprecation notice for exchangeToken() recommending loginWithCustomTokenExchange(), and corrects a variable reference (emailEnrollment.oobCode) in the MFA email enrollment code snippet. ChangesDocumentation corrections
Estimated code review effort: 1 (Trivial) | ~2 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Automated documentation drift fix. 2 findings addressed (1 P1 · 1 P2).
Changes
EXAMPLES.md— fixed wrong variablevoiceEnrollment→emailEnrollmentin the "Enrolling Email" MFA section (P1:ReferenceErrorif copy-pasted without the voice section)EXAMPLES.md— upgraded inlineexchangeToken()deprecation comment to a visible Markdown callout (P2: deprecated since v2.14.0 with no visible notice)Full Drift Report
EXAMPLES.mdvoiceEnrollment.oobCodein Enrolling Email section — should beemailEnrollment.oobCodeEXAMPLES.mdexchangeToken()deprecated in v2.14.0 but no visible callout block🤖 Generated with syncing-docs skill
Summary by CodeRabbit
exchangeToken(), with guidance to useloginWithCustomTokenExchange()instead.