Skip to content

Support generating ref docs for Firestore exp & lite #3966

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

Merged
merged 2 commits into from
Oct 27, 2020

Conversation

Feiyang1
Copy link
Member

  • Added support for generating ref docs for firestore exp and lite using api-extractor fork
  • Updated the ref docs

@changeset-bot
Copy link

changeset-bot bot commented Oct 20, 2020

⚠️ No Changeset found

Latest commit: c147129

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

@google-oss-bot
Copy link
Contributor

Binary Size Report

Affected SDKs

No changes between base commit (a5768b0) and head commit (61a2b46).

Test Logs

@google-oss-bot
Copy link
Contributor

Size Analysis Report

Affected Products

No changes between base commit (a5768b0) and head commit (61a2b46).

Test Logs

Copy link
Contributor

@schmidt-sebastian schmidt-sebastian left a comment

Choose a reason for hiding this comment

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

Do you know why the inline documentation does not show up? We have added JSDoc to all public methods.

@Feiyang1
Copy link
Member Author

Feiyang1 commented Oct 20, 2020

@schmidt-sebastian It's using the manually created d.ts files which have no comments.
I think you have an open PR that changes to generate d.ts files instead. We should get comments in the doc once it is merged.

@schmidt-sebastian
Copy link
Contributor

I think you have an open PR that changes to generate d.ts files instead. We should get comments in the doc once it is merged.

That's still a WIP :(

@Feiyang1 Feiyang1 merged commit e0f296d into master Oct 27, 2020
@Feiyang1 Feiyang1 deleted the fei-firestore-exp-ref branch October 27, 2020 21:29
@firebase firebase locked and limited conversation to collaborators Nov 27, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants