Skip to content

docs: fix doc typos found by g3 presubmit #9166

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 3 commits into from
Jul 17, 2025
Merged

docs: fix doc typos found by g3 presubmit #9166

merged 3 commits into from
Jul 17, 2025
+13 −13

Conversation

hsubox76
Copy link
Contributor

Backport for typos found and fixed while preparing reference docs for devsite in g3.

  • double "the"
  • misspelled "environment"
  • Use of "smart quotes" (double-quote character that is different for the opening and closing quote)

The g3 change only flagged the ai.groundingmetadata.md file but I searched the repo to find any other instances of those special characters and fixed the other ones I found (in a Firestore file).

@hsubox76 hsubox76 marked this pull request as ready for review July 15, 2025 22:46
@hsubox76 hsubox76 requested review from a team as code owners July 15, 2025 22:46
@hsubox76 hsubox76 requested a review from egilmorez July 15, 2025 22:46
@google-oss-bot
Copy link
Contributor

google-oss-bot commented Jul 15, 2025 •
edited
Loading

Size Analysis Report 1

Affected Products

  • @firebase/firestore

    • addDoc

      Size

      TypeBase (a9be675)Merge (b36814c)Diff
      size141 kB140 kB-248 B (-0.2%)
      size-with-ext-deps212 kB212 kB-251 B (-0.1%)

    • clearIndexedDbPersistence

      Size

      TypeBase (a9be675)Merge (b36814c)Diff
      size42.5 kB42.0 kB-435 B (-1.0%)
      size-with-ext-deps113 kB112 kB-418 B (-0.4%)

      Dependency

      TypeBase (a9be675)Merge (b36814c)Diff
      functions

      29 dependencies

      __PRIVATE__fail
__PRIVATE_argToString
__PRIVATE_checkForAndReportiOSError
__PRIVATE_cloneLongPollingOptions
__PRIVATE_compareUtf8Strings
__PRIVATE_createError
__PRIVATE_fieldPathFromArgument
__PRIVATE_fieldPathFromDotSeparatedString
__PRIVATE_getAndroidVersion
__PRIVATE_getMessageOrStack
__PRIVATE_hardAssert
__PRIVATE_indexedDbStoragePrefix
__PRIVATE_isIndexedDbTransactionError
__PRIVATE_isPlainObject
__PRIVATE_isSurrogate
__PRIVATE_logDebug
__PRIVATE_logError
__PRIVATE_logWarn
__PRIVATE_newQueryForPath
__PRIVATE_primitiveComparator
__PRIVATE_randomBytes
__PRIVATE_resultChangeType
__PRIVATE_validateIsNotUsedTogether
__PRIVATE_validateJSON
__PRIVATE_wrapRequest
clearIndexedDbPersistence
fail
getDocument
property

      28 dependencies

      __PRIVATE__fail
__PRIVATE_argToString
__PRIVATE_checkForAndReportiOSError
__PRIVATE_cloneLongPollingOptions
__PRIVATE_compareUtf8Strings
__PRIVATE_createError
__PRIVATE_fieldPathFromArgument
__PRIVATE_fieldPathFromDotSeparatedString
__PRIVATE_getAndroidVersion
__PRIVATE_getMessageOrStack
__PRIVATE_hardAssert
__PRIVATE_indexedDbStoragePrefix
__PRIVATE_isIndexedDbTransactionError
__PRIVATE_isPlainObject
__PRIVATE_isSurrogate
__PRIVATE_logDebug
__PRIVATE_logError
__PRIVATE_newQueryForPath
__PRIVATE_primitiveComparator
__PRIVATE_randomBytes
__PRIVATE_resultChangeType
__PRIVATE_validateIsNotUsedTogether
__PRIVATE_validateJSON
__PRIVATE_wrapRequest
clearIndexedDbPersistence
fail
getDocument
property

      - __PRIVATE_logWarn

    • deleteAllPersistentCacheIndexes

      Size

      TypeBase (a9be675)Merge (b36814c)Diff
      size107 kB107 kB-248 B (-0.2%)
      size-with-ext-deps178 kB178 kB-251 B (-0.1%)

    • deleteDoc

      Size

      TypeBase (a9be675)Merge (b36814c)Diff
      size134 kB134 kB-248 B (-0.2%)
      size-with-ext-deps206 kB206 kB-251 B (-0.1%)

    • disableNetwork

      Size

      TypeBase (a9be675)Merge (b36814c)Diff
      size123 kB123 kB-248 B (-0.2%)
      size-with-ext-deps194 kB194 kB-251 B (-0.1%)

    • disablePersistentCacheIndexAutoCreation

      Size

      TypeBase (a9be675)Merge (b36814c)Diff
      size107 kB107 kB-248 B (-0.2%)
      size-with-ext-deps178 kB178 kB-251 B (-0.1%)

    • enableIndexedDbPersistence

      Size

      TypeBase (a9be675)Merge (b36814c)Diff
      size198 kB198 kB-266 B (-0.1%)
      size-with-ext-deps270 kB270 kB-267 B (-0.1%)

    • enableMultiTabIndexedDbPersistence

      Size

      TypeBase (a9be675)Merge (b36814c)Diff
      size235 kB234 kB-266 B (-0.1%)
      size-with-ext-deps307 kB306 kB-267 B (-0.1%)

    • enableNetwork

      Size

      TypeBase (a9be675)Merge (b36814c)Diff
      size123 kB123 kB-248 B (-0.2%)
      size-with-ext-deps194 kB194 kB-251 B (-0.1%)

    • enablePersistentCacheIndexAutoCreation

      Size

      TypeBase (a9be675)Merge (b36814c)Diff
      size107 kB107 kB-248 B (-0.2%)
      size-with-ext-deps178 kB178 kB-251 B (-0.1%)

    • executeWrite

      Size

      TypeBase (a9be675)Merge (b36814c)Diff
      size134 kB133 kB-248 B (-0.2%)
      size-with-ext-deps205 kB205 kB-251 B (-0.1%)

    • getAggregateFromServer

      Size

      TypeBase (a9be675)Merge (b36814c)Diff
      size128 kB128 kB-248 B (-0.2%)
      size-with-ext-deps200 kB200 kB-251 B (-0.1%)

    • getCountFromServer

      Size

      TypeBase (a9be675)Merge (b36814c)Diff
      size128 kB128 kB-248 B (-0.2%)
      size-with-ext-deps200 kB200 kB-251 B (-0.1%)

    • getDoc

      Size

      TypeBase (a9be675)Merge (b36814c)Diff
      size161 kB160 kB-248 B (-0.2%)
      size-with-ext-deps232 kB232 kB-251 B (-0.1%)

    • getDocFromCache

      Size

      TypeBase (a9be675)Merge (b36814c)Diff
      size110 kB110 kB-248 B (-0.2%)
      size-with-ext-deps181 kB181 kB-251 B (-0.1%)

    • getDocFromServer

      Size

      TypeBase (a9be675)Merge (b36814c)Diff
      size161 kB160 kB-248 B (-0.2%)
      size-with-ext-deps232 kB232 kB-251 B (-0.1%)

    • getDocs

      Size

      TypeBase (a9be675)Merge (b36814c)Diff
      size161 kB160 kB-248 B (-0.2%)
      size-with-ext-deps232 kB232 kB-251 B (-0.1%)

    • getDocsFromCache

      Size

      TypeBase (a9be675)Merge (b36814c)Diff
      size116 kB116 kB-248 B (-0.2%)
      size-with-ext-deps187 kB187 kB-251 B (-0.1%)

    • getDocsFromServer

      Size

      TypeBase (a9be675)Merge (b36814c)Diff
      size160 kB160 kB-248 B (-0.2%)
      size-with-ext-deps232 kB232 kB-251 B (-0.1%)

    • loadBundle

      Size

      TypeBase (a9be675)Merge (b36814c)Diff
      size132 kB132 kB-248 B (-0.2%)
      size-with-ext-deps204 kB204 kB-251 B (-0.1%)

    • namedQuery

      Size

      TypeBase (a9be675)Merge (b36814c)Diff
      size108 kB107 kB-248 B (-0.2%)
      size-with-ext-deps179 kB179 kB-251 B (-0.1%)

    • onSnapshot

      Size

      TypeBase (a9be675)Merge (b36814c)Diff
      size161 kB161 kB-248 B (-0.2%)
      size-with-ext-deps233 kB233 kB-251 B (-0.1%)

    • onSnapshotResume

      Size

      TypeBase (a9be675)Merge (b36814c)Diff
      size170 kB170 kB-248 B (-0.1%)
      size-with-ext-deps242 kB242 kB-251 B (-0.1%)

    • onSnapshotsInSync

      Size

      TypeBase (a9be675)Merge (b36814c)Diff
      size156 kB156 kB-248 B (-0.2%)
      size-with-ext-deps228 kB228 kB-251 B (-0.1%)

    • persistentLocalCache

      Size

      TypeBase (a9be675)Merge (b36814c)Diff
      size195 kB194 kB-266 B (-0.1%)
      size-with-ext-deps266 kB266 kB-267 B (-0.1%)

    • persistentMultipleTabManager

      Size

      TypeBase (a9be675)Merge (b36814c)Diff
      size231 kB231 kB-266 B (-0.1%)
      size-with-ext-deps303 kB303 kB-267 B (-0.1%)

    • persistentSingleTabManager

      Size

      TypeBase (a9be675)Merge (b36814c)Diff
      size194 kB194 kB-266 B (-0.1%)
      size-with-ext-deps266 kB266 kB-267 B (-0.1%)

    • runTransaction

      Size

      TypeBase (a9be675)Merge (b36814c)Diff
      size139 kB139 kB-248 B (-0.2%)
      size-with-ext-deps211 kB211 kB-251 B (-0.1%)

    • setDoc

      Size

      TypeBase (a9be675)Merge (b36814c)Diff
      size140 kB140 kB-248 B (-0.2%)
      size-with-ext-deps212 kB211 kB-251 B (-0.1%)

    • setIndexConfiguration

      Size

      TypeBase (a9be675)Merge (b36814c)Diff
      size109 kB109 kB-248 B (-0.2%)
      size-with-ext-deps181 kB180 kB-251 B (-0.1%)

    • updateDoc

      Size

      TypeBase (a9be675)Merge (b36814c)Diff
      size140 kB140 kB-248 B (-0.2%)
      size-with-ext-deps212 kB212 kB-251 B (-0.1%)

    • waitForPendingWrites

      Size

      TypeBase (a9be675)Merge (b36814c)Diff
      size123 kB123 kB-248 B (-0.2%)
      size-with-ext-deps195 kB195 kB-251 B (-0.1%)

    • writeBatch

      Size

      TypeBase (a9be675)Merge (b36814c)Diff
      size142 kB142 kB-248 B (-0.2%)
      size-with-ext-deps214 kB214 kB-251 B (-0.1%)

Test Logs

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

@dlarocque
Copy link
Contributor

Thank you!

@changeset-bot changeset-bot
Copy link

changeset-bot bot commented Jul 16, 2025

⚠️ No Changeset found

Latest commit: 7c66aca

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

Size Report 1

Affected Products

  • @firebase/firestore

    TypeBase (a9be675)Merge (b36814c)Diff
    browser392 kB391 kB-579 B (-0.1%)
    main611 kB611 kB-431 B (-0.1%)
    module392 kB391 kB-579 B (-0.1%)
    react-native392 kB392 kB-579 B (-0.1%)

  • bundle

    TypeBase (a9be675)Merge (b36814c)Diff
    firestore (CSI Auto Indexing Disable and Delete)288 kB287 kB-518 B (-0.2%)
    firestore (CSI Auto Indexing Enable)288 kB287 kB-518 B (-0.2%)
    firestore (Persistence)319 kB319 kB-267 B (-0.1%)
    firestore (Query Cursors)259 kB258 kB-251 B (-0.1%)
    firestore (Query)256 kB256 kB-251 B (-0.1%)
    firestore (Read data once)246 kB246 kB-251 B (-0.1%)
    firestore (Read Write w Persistence)339 kB339 kB-518 B (-0.2%)
    firestore (Realtime updates)246 kB246 kB-251 B (-0.1%)
    firestore (Transaction)225 kB224 kB-251 B (-0.1%)
    firestore (Write data)226 kB226 kB-251 B (-0.1%)

  • firebase

    TypeBase (a9be675)Merge (b36814c)Diff
    firebase-compat.js800 kB800 kB-513 B (-0.1%)
    firebase-firestore-compat.js349 kB349 kB-513 B (-0.1%)
    firebase-firestore.js455 kB455 kB-579 B (-0.1%)

Test Logs

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

@hsubox76 hsubox76 merged commit 5748005 into main Jul 17, 2025
67 of 69 checks passed
@hsubox76 hsubox76 deleted the ch-doc-typos branch July 17, 2025 17:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@DellaBitta DellaBitta DellaBitta approved these changes

@rachelsaunders rachelsaunders rachelsaunders approved these changes

@egilmorez egilmorez Awaiting requested review from egilmorez

Assignees

@egilmorez egilmorez

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@hsubox76 @google-oss-bot @dlarocque @DellaBitta @rachelsaunders @egilmorez
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy