The Wayback Machine - https://web.archive.org/web/20211202113233/https://github.com/firebase/firebase-js-sdk/pull/3966
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

Jump to bottom

Support generating ref docs for Firestore exp & lite #3966

Merged
merged 2 commits into from Oct 27, 2020
Merged

Support generating ref docs for Firestore exp & lite #3966

merged 2 commits into from Oct 27, 2020

Conversation

@Feiyang1
Copy link
Member

@Feiyang1 Feiyang1 commented Oct 20, 2020

  • 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 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

Loading

@google-oss-bot
Copy link
Contributor

@google-oss-bot google-oss-bot commented Oct 20, 2020

Binary Size Report

Affected SDKs

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

Test Logs

Loading

@google-oss-bot
Copy link
Contributor

@google-oss-bot google-oss-bot commented Oct 20, 2020

Size Analysis Report

Affected Products

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

Test Logs

Loading

schmidt-sebastian
schmidt-sebastian reviewed Oct 20, 2020
View changes
Copy link
Member

@schmidt-sebastian schmidt-sebastian left a comment

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

Loading

@Feiyang1
Copy link
Member Author

@Feiyang1 Feiyang1 commented Oct 20, 2020 •
edited
Loading

@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.

Loading

@schmidt-sebastian
Copy link
Member

@schmidt-sebastian schmidt-sebastian commented Oct 21, 2020

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 :(

Loading

@Feiyang1 Feiyang1 merged commit e0f296d into master Oct 27, 2020
14 of 15 checks passed
Loading
@Feiyang1 Feiyang1 deleted the fei-firestore-exp-ref branch Oct 27, 2020
@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.
Reviewers

@hsubox76 hsubox76

@schmidt-sebastian schmidt-sebastian

@hiranya911 hiranya911

Assignees

@hsubox76 hsubox76

@schmidt-sebastian schmidt-sebastian

Labels
None yet
Projects
None yet
Milestone
No milestone
Linked issues

Successfully merging this pull request may close these issues.

None yet

4 participants
@Feiyang1 @google-oss-bot @schmidt-sebastian @hsubox76