Skip to content
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

Broken link in the docs #7606

Open
marcusx2 opened this issue Sep 6, 2023 · 2 comments
Open

Broken link in the docs #7606

marcusx2 opened this issue Sep 6, 2023 · 2 comments

Comments

@marcusx2
Copy link

marcusx2 commented Sep 6, 2023

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.

@marcusx2 marcusx2 added new A new issue that hasn't be categoirzed as question, bug or feature request question labels Sep 6, 2023
@jbalidiong jbalidiong added needs-attention and removed new A new issue that hasn't be categoirzed as question, bug or feature request labels Sep 6, 2023
@jbalidiong
Copy link
Contributor

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

@hsubox76
Copy link
Contributor

hsubox76 commented Sep 6, 2023

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:

microsoft/rushstack#3430
microsoft/rushstack#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.

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

No branches or pull requests

4 participants