Skip to content

Fix deprecation documentation #5286

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Aug 12, 2021
Merged

Fix deprecation documentation #5286

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
62e2a26
Update index.d.ts
zwu52 Aug 12, 2021
71c4fb3
Update index.d.ts
zwu52 Aug 12, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion packages/firebase/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7419,7 +7419,7 @@ declare namespace firebase.messaging {
*
* @param callback The function to handle the push message.
*
* @deprecated onBackgroundMessage(nextOrObserver: firebase.NextFn<MessagePayload>|
* @deprecated Use onBackgroundMessage(nextOrObserver: firebase.NextFn<MessagePayload>|
Copy link
Contributor

Choose a reason for hiding this comment

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

Also, will this fix the way this item gets conflated with the following Observer-Unsubscribe item?

Ideally we'd have a way to gen the docs and eyeball that.

Copy link
Contributor

Choose a reason for hiding this comment

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

Those all belong together, the Observer and error are part of the signature and the Unsubscribe is the return type. There could be some spaces before the | and after the comma after errorFn,. But actually, do we need the whole signature here, can we just say "Use onBackgroundMessage()" or "Use {@link firebase.messaging.Messaging.onBackgroundMessage}"?

Docs can be generated locally by running

yarn
yarn docgen:js

at the root of the repo.

After running that, the affected html file will be found at scripts/docgen/html/js/firebase.messaging.Messaging.html

Copy link
Member Author

Choose a reason for hiding this comment

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

added some spaces.

Don't know if should use the full method signature of {@link firebase.messaging.Messaging.onBackgroundMessage}. If later, need to change other ones.

* firebase.Observer<MessagePayload>, error?: firebase.ErrorFn,completed?: firebase.CompleteFn):
* firebase.Unsubscribe.
*/
Expand Down