Skip to content

Fix documentation links for function overloads and improve readability of function headings #7864

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.

Sign up for GitHub

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
Merged
merged 8 commits into from
Dec 15, 2023
Merged

Fix documentation links for function overloads and improve readability of function headings #7864

merged 8 commits into from
Dec 15, 2023

Conversation

MarkDuckworth
Copy link
Contributor

@MarkDuckworth MarkDuckworth commented Dec 12, 2023 •
edited
Loading

Fix documentation links for function overloads.

Uses this DevSite feature for custom header IDs.

Fixes: #7667
Fixes: b/316190402

@changeset-bot changeset-bot
Copy link

changeset-bot bot commented Dec 12, 2023 •
edited
Loading

⚠️ No Changeset found

Latest commit: 0303efd

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

google-oss-bot commented Dec 12, 2023 •
edited
Loading

Size Report 1

Affected Products

  • @firebase/firestore

    TypeBase (42bfb0b)Merge (8fa6b1d)Diff
    browser374 kB375 kB+266 B (+0.1%)
    esm5360 kB360 kB+160 B (+0.0%)
    main576 kB576 kB+298 B (+0.1%)
    module374 kB375 kB+266 B (+0.1%)
    react-native375 kB375 kB+266 B (+0.1%)

  • @firebase/firestore-lite

    TypeBase (42bfb0b)Merge (8fa6b1d)Diff
    browser109 kB109 kB+266 B (+0.2%)
    esm5106 kB106 kB+160 B (+0.2%)
    main150 kB150 kB+298 B (+0.2%)
    module109 kB109 kB+266 B (+0.2%)
    react-native109 kB109 kB+266 B (+0.2%)

  • bundle

    TypeBase (42bfb0b)Merge (8fa6b1d)Diff
    firestore (Read Write w Persistence)?321 kB? (?)
    firestore (Transaction)204 kB204 kB+76 B (+0.0%)
    firestore-lite (Transaction)86.4 kB86.5 kB+76 B (+0.1%)

  • firebase

    TypeBase (42bfb0b)Merge (8fa6b1d)Diff
    firebase-compat.js779 kB779 kB+155 B (+0.0%)
    firebase-firestore-compat.js340 kB341 kB+463 B (+0.1%)
    firebase-firestore-lite.js116 kB117 kB+266 B (+0.2%)
    firebase-firestore.js434 kB434 kB+266 B (+0.1%)

Test Logs

  1. https://storage.googleapis.com/firebase-sdk-metric-reports/WAKjzmy0qC.html

@google-oss-bot
Copy link
Contributor

google-oss-bot commented Dec 12, 2023 •
edited
Loading

Size Analysis Report 1

Affected Products

  • @firebase/firestore

    • arrayRemove

      Size

      TypeBase (42bfb0b)Merge (8fa6b1d)Diff
      size30.5 kB30.6 kB+74 B (+0.2%)
      size-with-ext-deps100 kB101 kB+372 B (+0.4%)

      External Dependency

      ModuleBase (42bfb0b)Merge (8fa6b1d)Diff
      @firebase/util

      FirebaseError
getModularInstance

      FirebaseError
deepEqual
getModularInstance

      + deepEqual

    • arrayUnion

      Size

      TypeBase (42bfb0b)Merge (8fa6b1d)Diff
      size30.5 kB30.6 kB+74 B (+0.2%)
      size-with-ext-deps100 kB101 kB+372 B (+0.4%)

      External Dependency

      ModuleBase (42bfb0b)Merge (8fa6b1d)Diff
      @firebase/util

      FirebaseError
getModularInstance

      FirebaseError
deepEqual
getModularInstance

      + deepEqual

    • increment

      Size

      TypeBase (42bfb0b)Merge (8fa6b1d)Diff
      size18.6 kB18.6 kB+23 B (+0.1%)
      size-with-ext-deps88.5 kB88.5 kB+23 B (+0.0%)

    • runTransaction

      Size

      TypeBase (42bfb0b)Merge (8fa6b1d)Diff
      size123 kB123 kB+76 B (+0.1%)
      size-with-ext-deps194 kB194 kB+76 B (+0.0%)

Test Logs

  1. https://storage.googleapis.com/firebase-sdk-metric-reports/e5gF1gnJ2i.html

egilmorez
egilmorez approved these changes Dec 12, 2023
View reviewed changes
Copy link
Contributor

@egilmorez egilmorez left a comment

Choose a reason for hiding this comment

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

Links LGTM, thanks!

hsubox76
hsubox76 approved these changes Dec 14, 2023
View reviewed changes
Copy link
Contributor

@hsubox76 hsubox76 left a comment

Choose a reason for hiding this comment

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

LG, thanks for doing this! One question about the hash but I think it's fine, good solution to not having easy access to the order (I think that's why).

hsubox76
hsubox76 requested changes Dec 14, 2023
View reviewed changes
Copy link
Contributor

@hsubox76 hsubox76 left a comment

Choose a reason for hiding this comment

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

I actually forgot one important thing. This is a published package that is also consumed by firebase-admin-node and firebase-functions, and it's excluded from being covered by changesets, so we have to update the version and CHANGELOG.md manually. I would give this a minor bump?

@MarkDuckworth MarkDuckworth changed the title Fix documentation links for function overloads Fix documentation links for function overloads and improve readability of function headings Dec 15, 2023
@MarkDuckworth
Merge branch 'markduckworth/documentation-links-for-function-overload…
5153761 
…s' of github.com:firebase/firebase-js-sdk into markduckworth/documentation-links-for-function-overloads
@MarkDuckworth
Update version and readme.
0303efd
@MarkDuckworth
Copy link
Contributor Author

I'm okay with a minor version bump. I updated the version and readme. I also merged in #7869 to this PR so we only make one version bump for the api-documenter.

hsubox76
hsubox76 approved these changes Dec 15, 2023
View reviewed changes
Copy link
Contributor

@hsubox76 hsubox76 left a comment

Choose a reason for hiding this comment

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

Thanks for figuring this out!

@MarkDuckworth MarkDuckworth merged commit 07a65d3 into master Dec 15, 2023
@MarkDuckworth MarkDuckworth deleted the markduckworth/documentation-links-for-function-overloads branch December 15, 2023 23:17
@firebase firebase locked and limited conversation to collaborators Jan 15, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@egilmorez egilmorez egilmorez approved these changes

@DellaBitta DellaBitta DellaBitta approved these changes

@hsubox76 hsubox76 hsubox76 approved these changes

@markarndt markarndt markarndt approved these changes

@kevinthecheung kevinthecheung Awaiting requested review from kevinthecheung

Assignees

@hsubox76 hsubox76

@markarndt markarndt

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

both collection(reference, path, pathSegments) points to the same place
6 participants
@MarkDuckworth @google-oss-bot @egilmorez @DellaBitta @hsubox76 @markarndt