Skip to content

[FR] docs: Please update comments in source code. #1101

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
FrancescoJo opened this issue Dec 1, 2020 · 1 comment · Fixed by #1106
Closed

[FR] docs: Please update comments in source code. #1101

FrancescoJo opened this issue Dec 1, 2020 · 1 comment · Fixed by #1106

Comments

@FrancescoJo
Copy link

FrancescoJo commented Dec 1, 2020

Is your feature request related to a problem? Please describe.
https://github.com/firebase/firebase-admin-node/blob/master/src/auth/index.ts#L503

Now in december 2020, Firebase auth supports various third pary login methods more than anonymous, password, facebook.com, github.com, google.com, twitter.com, or custom. However, only all these methods that I listed are written in source code comments, which causes confusion.

Of course enumerating all possible tokens like this way is way much better than other sdks(e.g.: Firebase Java sdk), but it needs to be updated. At least in my case, I can confirm there are more providerIds are returned by auth API, such as apple.com or microsoft.com.

So this is my little proposal: could you guys update the comments to elaborate all possible providerIds please?

Describe the solution you'd like
Comment includes all possible providerId candidates: not in Java sdk way

Describe alternatives you've considered
Or sync to Java sdk way which I think the worst solution but it would decrease confusion

Additional context
n/a

Thanks for reading.

@google-oss-bot
Copy link

I found a few problems with this issue:

  • I couldn't figure out how to label this issue, so I've labeled it for a human to triage. Hang tight.
  • This issue does not seem to follow the issue template. Make sure you provide all the required information.

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

Successfully merging a pull request may close this issue.

4 participants