Fix deprecation documentation

[zwu52]

Deprecated method doc should start with "Use ...".

This will fix: b/170682742

[changeset-bot]

⚠️ No Changeset found

Latest commit: 71c4fb3

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

[github-actions]

Changeset File Check ⚠️

• Changeset formatting error in following file:

  Package "firebase-compat-typings-test" must depend on the current version of "firebase-exp": "9.0.0-beta.8" vs "file:../../packages-exp/firebase-exp"
  Package "firebase-compat-typings-test" must depend on the current version of "firebase-exp": "9.0.0-beta.8" vs "file:../../packages-exp/firebase-exp"
  Package "firebase-compat-typings-test" must depend on the current version of "firebase-exp": "9.0.0-beta.8" vs "file:../../packages-exp/firebase-exp"
  Some packages have been changed but no changesets were found. Run `changeset add` to resolve this error.
  If this change doesn't need a release, run `changeset add --empty`.
  

[google-oss-bot]

Binary Size Report

Affected SDKs

No changes between base commit (e83826a) and head commit (f63d962).

Test Logs

• Base (e83826af): https://github.com/firebase/firebase-js-sdk/actions/runs/1124760980
• Head (f63d9623): https://github.com/firebase/firebase-js-sdk/actions/runs/1125077119

[egilmorez]

Should this be backticked, or will it be rendered as code font without them?

[google-oss-bot]

Size Analysis Report

Affected Products

No changes between base commit (e83826a) and head commit (f63d962).

Test Logs

• Base (e83826a): https://github.com/firebase/firebase-js-sdk/actions/runs/1124760980
• Head (f63d962): https://github.com/firebase/firebase-js-sdk/actions/runs/1125077119

[egilmorez]

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.

[hsubox76]

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

[zwu52]

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.