search

firebase / firebase-js-sdk

Firebase Javascript SDK
https://firebase.google.com/docs/web/setup
Other
4.86k stars 893 forks source link

Broken link in the docs #7606

Open marcusx2 opened 1 year ago

marcusx2 commented 1 year ago

Operating System

macOS

Browser Version

Safari 16.5.2

Firebase SDK Version

10.1.0

Firebase SDK Product:

Auth

Describe your project's tooling

index.html with source tag.

Describe the problem

On this part, you have this broken link at the end of number 4.

Steps and code to reproduce issue

Already explained.

jbalidiong commented 1 year ago

Hi @marcusx2, thanks for the feedback with our documentation. I'll communicate this with our engineers, we’ll check the docs affected.

hsubox76 commented 1 year ago

The problem is that API Extractor (the tool used for generated modular - v9+ - documentation), at least as it's currently set up, doesn't document inherited methods. In the modular JS SDK API (v9+), the various providers (such as GoogleAuthProvider) extend the abstract class BaseOAuthProvider which in turn extends the abstract class FederatedAuthProvider. This last base class is the one with setCustomParameters(). These two abstract base classes are not exported, because they're not meant for public use, but that means that API Extractor is not getting the inherited methods and pulling them into the documentation.

There are some issues in the rushstack repo (the monorepo for api-extractor/api-documenter) regarding this, and there may be some setting that enables the documentation to follow the trail to the inherited methods without having to export the non-public base classes:

https://github.com/microsoft/rushstack/issues/3430 https://github.com/microsoft/rushstack/pull/3552

We'll put this on our to-do list, but if this is impacting any users who want it fixed sooner, we'd welcome any help sorting out exactly how to get api-extractor to do what we need, maybe starting with looking through those issues.