Mark Auth error callbacks as deprecated #6262
Merged
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
hsubox76
requested review from
avolkovi,
lisajian,
sam-gc and
yuchenshi
as code owners
|
sam-gc
approved these changes
May 10, 2022
Size Report 1Affected Products
Test Logs |
Size Analysis Report 1Affected ProductsNo changes between base commit (e5a4654) and merge commit (792a421).Test Logs |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
errorandcompletedcallbacks inonAuthStateChanged()andonIdTokenChanged()have always been no-op, even since before v9. Changing the docs to reflect this and to mark them as deprecated in preparation for removing them in a future major bump.@deprecatedtag on a single param, only on an entire function or interface, so I just put the word "Deprecated" in the comment. That means we won't get the big red box that devsite puts on deprecated items: https://firebase.google.com/docs/reference/js/analytics.item I don't think there's a way around it, I don't think devsite can put that box around params either, considering the way params are formatted.packages/auth/src/core/index.tsis the actual source of truth for the docgen, so copied some comment formatting from the other file into here.@remarkstag doesn't seem to have any effect on the actual body text in the reference doc: https://firebase.google.com/docs/reference/js/auth#onauthstatechanged However, in the table of contents at the top of that doc, it cuts off the part after the@remarkstag for brevity within the table.