Skip to content

docs(auth): pass auth to RecaptchaVerifier examples#9999

Open
KirtiRamchandani wants to merge 1 commit into
firebase:mainfrom
KirtiRamchandani:docs/recaptcha-verifier-auth-example
Open

docs(auth): pass auth to RecaptchaVerifier examples#9999
KirtiRamchandani wants to merge 1 commit into
firebase:mainfrom
KirtiRamchandani:docs/recaptcha-verifier-auth-example

Conversation

@KirtiRamchandani
Copy link
Copy Markdown

Problem

The generated Auth docs include RecaptchaVerifier examples that omit the required auth constructor argument, matching #7630.

Root cause

The source JSDoc examples still used the old constructor shape, even though RecaptchaVerifier now takes authExtern as its first parameter.

Solution

Update the phone auth examples to construct RecaptchaVerifier(auth, 'recaptcha-container').

Tests run

  • .\node_modules\.bin\prettier.cmd --check packages/auth/src/platform_browser/providers/phone.ts packages/auth/src/platform_browser/strategies/phone.ts
  • ..\..\node_modules\.bin\eslint.cmd -c .eslintrc.js src/platform_browser/providers/phone.ts src/platform_browser/strategies/phone.ts --ignore-path ../../.gitignore from packages/auth
  • git diff --check

Fixes #7630

@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented May 25, 2026

⚠️ No Changeset found

Latest commit: 762b513

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

Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request updates the JSDoc code examples in the phone authentication modules to correctly reflect the RecaptchaVerifier constructor, which now requires an auth instance as its first argument. I have no feedback to provide.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

RecaptchaVerifier example missing authExtern parameter

1 participant