This repository was archived by the owner on Mar 17, 2025. It is now read-only.
Updated $signInWithPopup() and $signInWithRedirect() docs #896
Conversation
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
katowulf
approved these changes
Jan 11, 2017
Contributor
katowulf
left a comment
katowulf
left a comment
There was a problem hiding this comment.
Looks good. Two little nitpicks to consider. I'll mark this lgtm as I'm not sure they're actionable.
docs/reference.md
Outdated
| Authenticates the client using a credential (potentially created from OAuth Tokens). This function takes one | ||
| arguments: the credential object. This may be obtained from individual auth providers under `firebase.auth()`; | ||
| Authenticates the client using a credential (potentially created from OAuth tokens). This function | ||
| takes a single argument: the credential object. This may be obtained from individual auth providers |
Contributor
There was a problem hiding this comment.
This sentence doesn't really help me understand how to create a credential object and I think it's going to be easy to miss that firebase.auth() refers to the underlying SDK.
Sadly, there doesn't seem to be a good example in the auth guide or the api reference to help clear this up. So maybe ignore unless you have ideas.
docs/reference.md
Outdated
| data about the signed-in user. If unsuccessful, the promise will be rejected with an `Error` object. | ||
|
|
||
| Firebase currently supports Facebook, GitHub, Google, and Twitter authentication. Refer to | ||
| Firebase currently supports Facebook, GitHub, Google, and Twitter authentication. Refer to the |
Contributor
There was a problem hiding this comment.
Firebase currently supports Facebook, GitHub, Google, and Twitter identity providers for use with $signInWithCredential. (We support other authentication methods: email/password, anonymous, and custom)
Contributor
|
lgtm ☃ |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
3 participants
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.
Description
Clarifies and adds additional examples to the reference docs for
$signInWithPopup()and$signInWithRedirect().Closes #894.
Code sample
N/A