Spelling #8280

jsoref · 2024-05-30T23:22:01Z

Discussion

Testing

Make sure all existing tests in the repository pass after your change. -- They do (although, many of them required fixes in Fix workflows for forks #8275 for me to validate)
If you fixed a bug or added a feature, add a new test to cover your code. -- This can be done by applying a variant of jsoref@spell-check, but I'd prefer to leave that outside the scope of this PR

API Changes

I believe there's one API change included:
jsoref@10eacae

I've included it in the hopes that it isn't an API and, thus, can be changed. If it's an API and can't be changed, it's trivial for me to drop it (just as I'm more than happy to drop any other changes).

changeset-bot · 2024-05-30T23:22:05Z

🦋 Changeset detected

Latest commit: 8433b90

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 36 packages

Name	Type
@firebase/installations-compat	Patch
@firebase/remote-config-compat	Patch
@firebase/installations-types	Patch
@firebase/remote-config-types	Patch
@firebase/performance-compat	Patch
@firebase/rules-unit-testing	Patch
@firebase/webchannel-wrapper	Patch
@firebase/performance-types	Patch
@firebase/analytics-compat	Patch
@firebase/app-check-compat	Patch
@firebase/firestore-compat	Patch
@firebase/functions-compat	Patch
@firebase/messaging-compat	Patch
@firebase/database-compat	Patch
@firebase/database-types	Patch
@firebase/storage-compat	Patch
@firebase/installations	Patch
@firebase/remote-config	Patch
@firebase/auth-compat	Patch
@firebase/performance	Patch
@firebase/app-compat	Patch
@firebase/analytics	Patch
@firebase/app-check	Patch
@firebase/component	Patch
@firebase/firestore	Patch
@firebase/functions	Patch
@firebase/messaging	Patch
@firebase/database	Patch
firebase	Patch
@firebase/template	Patch
@firebase/vertexai-preview	Patch
@firebase/storage	Patch
@firebase/logger	Patch
@firebase/auth	Patch
@firebase/util	Patch
@firebase/app	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

jsoref · 2024-05-30T23:24:11Z

docs-devsite/database.datasnapshot.md

@@ -38,7 +38,7 @@ export declare class DataSnapshot
 |  [child(path)](./database.datasnapshot.md#datasnapshotchild) |  | Gets another <code>DataSnapshot</code> for the location at the specified relative path.<!-- -->Passing a relative path to the <code>child()</code> method of a DataSnapshot returns another <code>DataSnapshot</code> for the location at the specified relative path. The relative path can either be a simple child name (for example, "ada") or a deeper, slash-separated path (for example, "ada/name/first"). If the child location has no data, an empty <code>DataSnapshot</code> (that is, a <code>DataSnapshot</code> whose value is <code>null</code>) is returned. |
 |  [exists()](./database.datasnapshot.md#datasnapshotexists) |  | Returns true if this <code>DataSnapshot</code> contains any data. It is slightly more efficient than using <code>snapshot.val() !== null</code>. |
 |  [exportVal()](./database.datasnapshot.md#datasnapshotexportval) |  | Exports the entire contents of the DataSnapshot as a JavaScript object.<!-- -->The <code>exportVal()</code> method is similar to <code>val()</code>, except priority information is included (if available), making it suitable for backing up your data. |
-|  [forEach(action)](./database.datasnapshot.md#datasnapshotforeach) |  | Enumerates the top-level children in the <code>IteratedDataSnapshot</code>.<!-- -->Because of the way JavaScript objects work, the ordering of data in the JavaScript object returned by <code>val()</code> is not guaranteed to match the ordering on the server nor the ordering of <code>onChildAdded()</code> events. That is where <code>forEach()</code> comes in handy. It guarantees the children of a <code>DataSnapshot</code> will be iterated in their query order.<!-- -->If no explicit <code>orderBy*()</code> method is used, results are returned ordered by key (unless priorities are used, in which case, results are returned by priority). |
+|  [forEach(action)](./database.datasnapshot.md#datasnapshotforeach) |  | Enumerates the top-level children in the <code>IteratedDataSnapshot</code>.<!-- -->Because of the way JavaScript objects work, the ordering of data in the JavaScript object returned by <code>val()</code> is neither guaranteed to match the ordering on the server nor the ordering of <code>onChildAdded()</code> events. That is where <code>forEach()</code> comes in handy. It guarantees the children of a <code>DataSnapshot</code> will be iterated in their query order.<!-- -->If no explicit <code>orderBy*()</code> method is used, results are returned ordered by key (unless priorities are used, in which case, results are returned by priority). |


I'm happy to drop any of my proposed changes.

neither/nor is the generally recommended way to write this, and as this is documentation, using it seems reasonable.

.github/ISSUE_TEMPLATE/bug_report_v2.yaml

jsoref · 2024-05-30T23:24:51Z

docs-devsite/firestore_.md

@@ -2598,7 +2598,7 @@ export declare type OrderByDirection = 'desc' | 'asc';

 ## PartialWithFieldValue

-Similar to Typescript's `Partial<T>`<!-- -->, but allows nested fields to be omitted and FieldValues to be passed in as property values.
+Similar to TypeScript's `Partial<T>`<!-- -->, but allows nested fields to be omitted and FieldValues to be passed in as property values.


jsoref · 2024-05-30T23:26:43Z

packages/app-check/src/api.test.ts

@@ -10,7 +10,7 @@
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or ied.
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.


generally, lawyers get annoyed by changes to licenses...

A peer suggested that someone did a global search and replace s/impl//. -- I believe they're correct.

packages/app-compat/src/public-types.ts

packages/firebase/compat/rollup.config.js

packages/firestore/src/local/memory_remote_document_cache.ts

packages/firestore/test/unit/remote/bloom_filter.test.ts

packages/performance/src/services/perf_logger.ts

jsoref · 2024-05-30T23:46:36Z

scripts/docgen-compat/theme/assets/css/main.css

@@ -518,7 +518,7 @@ ul.tsd-descriptions.active > .tsd-description.fade-out { -webkit-animation: fade
 ul.tsd-descriptions h4, ul.tsd-descriptions .tsd-index-panel h3, .tsd-index-panel ul.tsd-descriptions h3 { font-size: 16px; margin: 1em 0 0.5em 0; }

 ul.tsd-parameters, ul.tsd-type-parameters { list-style: square; margin: 0; padding-left: 20px; }
-ul.tsd-parameters > li.tsd-parameter-siganture, ul.tsd-type-parameters > li.tsd-parameter-siganture { list-style: none; margin-left: -20px; }
+ul.tsd-parameters > li.tsd-parameter-signature, ul.tsd-type-parameters > li.tsd-parameter-signature { list-style: none; margin-left: -20px; }


It's unclear if this CSS class name change was also made in the corresponding HTML. If not, maybe revert this?

There's no sign of that typo in html https://github.com/search?q=repo%3Afirebase%2Ffirebase-js-sdk%20%22siganture%22&type=code

Or the attribute for that matter? https://github.com/search?q=repo%3Afirebase%2Ffirebase-js-sdk+%22tsd-parameter%22&type=code

It appears to be from something else that isn't used here..
https://github.com/search?q=repo%3Aangular-redux%2Fstore%20%22tsd-parameter-siganture%22&type=code

Happy to drop. I'll probably try to send a PR to them at some point...

jsoref · 2024-05-30T23:49:44Z

packages/firestore/test/integration/api/snapshot_listener_source.test.ts

-snasphot_listener_source.test.ts +snapshot_listener_source.test.ts

jsoref · 2024-05-30T23:50:11Z

repo-scripts/prune-dts/tests/resolves-generics-through-inheritance.input.d.ts

-inheritence.input.d.ts +inheritance.input.d.ts

egilmorez

This is a super useful effort that I enthusiasticallyt endorse (could the same tooling be used on similar TypeScript source, like the Cloud Functions reference?), but wow – over 200 files is a lot to review at once, for a human. Next time around, would be great to break it down into categories of some kind, like proper naming issues (Github> GitHub), misspellings of nouns, misspellings of verbs, whatever.

Also, for some of the more sophisticated errata, we may need to tweak the algorithm to prevent the neither/nor errors that I picked out. Hope I didn't miss any similar things ( placement of "only" often causes similar issues).

docs-devsite/database.datasnapshot.md

docs-devsite/vertexai-preview.chatsession.md

packages/auth/src/api/index.test.ts

packages/database/src/api/Reference_impl.ts

packages/vertexai/src/methods/chat-session.ts

jsoref · 2024-06-24T04:54:53Z

The changes are all manual (more or less), and anything that isn't a simple replacement is very manual (especially things like neither).

Splitting is more or less possible -- it's easy for me to group commits together, or split by directory. It's fairly painful for me to split by part of speech if a word is used in more than one part of speech (and gets prohibitive as the word count grows -- it's error prone, and as a human, I make mistakes like everyone else), but it's certainly not a problem for me to peel off individual commits or group commits together into separate PRs -- I just need direction. For smaller repositories, I can split by "code" vs "comment" -- although I really don't like to do it as it isn't particularly safe -- it's much cleaner to split by directory or possibly file extension.

The only thing that's fully automated is identifying potential problems. I can certainly run the tooling on any repository if people are interested. Sometimes I rely on Google Sheets for word corrections, although of late, I've just been using Google Chrome suggestions.

egilmorez

I think jsoref fixed or backed out content related to my neither/nor suggestions (not easy to immediately discover that due to the massive size of this PR), so I think I'm happy to approve. Thanks!

jsoref · 2024-06-28T21:19:59Z

Do I need to worry about the changeset bot?

Note that https://github.com/firebase/firebase-js-sdk/actions/runs/9639724064/job/26582355096?pr=8280 is failing (I can't remember the state of this, I split most other CI failures into other PRs...)

MarkDuckworth

LGTM with comments. I reviewed packages/firestore and other top-level folders outside of packages/.

packages/firestore/src/local/memory_remote_document_cache.ts

packages/firestore/test/unit/remote/bloom_filter.test.ts

.github/ISSUE_TEMPLATE/bug_report_v2.yaml

MarkDuckworth · 2024-07-16T13:54:21Z

scripts/docgen-compat/theme/assets/css/main.css

@@ -518,7 +518,7 @@ ul.tsd-descriptions.active > .tsd-description.fade-out { -webkit-animation: fade
 ul.tsd-descriptions h4, ul.tsd-descriptions .tsd-index-panel h3, .tsd-index-panel ul.tsd-descriptions h3 { font-size: 16px; margin: 1em 0 0.5em 0; }

 ul.tsd-parameters, ul.tsd-type-parameters { list-style: square; margin: 0; padding-left: 20px; }
-ul.tsd-parameters > li.tsd-parameter-siganture, ul.tsd-type-parameters > li.tsd-parameter-siganture { list-style: none; margin-left: -20px; }
+ul.tsd-parameters > li.tsd-parameter-signature, ul.tsd-type-parameters > li.tsd-parameter-signature { list-style: none; margin-left: -20px; }


It's unclear if this CSS class name change was also made in the corresponding HTML. If not, maybe revert this?

DellaBitta

Hi @jsoref, thanks for the PR!

Could you add a changeset (run yarn changeset) and mark all packages with code changes as patch with the note Fixed typos in documentation and in some internal variables and parameters. ?

Also looks like you have a format error. Could your run the following commands:

yarn format
yarn docgen:all

You might need to merge the main branch into your branch because there were some changes to the documentation script a few weeks ago.

packages/auth-compat/CHANGELOG.md

packages/app-compat/src/public-types.ts

packages/auth/src/api/authentication/mfa.test.ts

packages/performance/src/services/perf_logger.ts

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

jsoref · 2024-07-16T21:20:21Z

@DellaBitta: I can't get yarn to cooperate

jsoref@jsoref-mbp firebase-js-sdk % node --version
v20.11.0
jsoref@jsoref-mbp firebase-js-sdk % yarn
➤ YN0000: · Yarn 4.2.1
➤ YN0000: ┌ Resolution step
➤ YN0001: │ Error: closure-net@https://github.com/google/closure-net.git#commit=0412666e8f29b8ae69decb1fdc7ead635a5cf43e: Manifest not found
    at AE.find (/Users/jsoref/.yarn/releases/yarn-4.2.1.cjs:140:120021)
    at async /Users/jsoref/.yarn/releases/yarn-4.2.1.cjs:520:11979
    at async Object.xZe (/Users/jsoref/.yarn/releases/yarn-4.2.1.cjs:140:53847)
    at async I2.resolve (/Users/jsoref/.yarn/releases/yarn-4.2.1.cjs:520:11940)
    at async Dd.resolve (/Users/jsoref/.yarn/releases/yarn-4.2.1.cjs:141:1451)
    at async Dd.resolve (/Users/jsoref/.yarn/releases/yarn-4.2.1.cjs:141:1451)
    at async /Users/jsoref/.yarn/releases/yarn-4.2.1.cjs:210:7249
    at async Ky (/Users/jsoref/.yarn/releases/yarn-4.2.1.cjs:140:53910)
    at async ne (/Users/jsoref/.yarn/releases/yarn-4.2.1.cjs:210:7231)
    at async Promise.allSettled (index 1)
➤ YN0000: └ Completed in 0s 873ms
➤ YN0000: · Failed with errors in 0s 883ms

I've given permission to push into my branch...

DellaBitta · 2024-07-18T15:23:46Z

Done! Waiting for CI to execute now.

Numerous fixes to spelling across the SDK.

jsoref requested review from a team, hsubox76, erikeldridge, jposuna, avolkovi, yoyomyo, sam-gc, yuchenshi, lisajian, Xiaoshouzi-gh, zwu52, maneesht, tonyjhuang and aashishpatil-g as code owners May 30, 2024 23:22

jsoref commented May 30, 2024

View reviewed changes

jsoref force-pushed the spelling branch from 10eacae to cc78cf1 Compare May 30, 2024 23:48

jsoref commented May 30, 2024

View reviewed changes

dlarocque requested a review from egilmorez May 31, 2024 18:34

egilmorez reviewed Jun 23, 2024

View reviewed changes

jsoref force-pushed the spelling branch from cc78cf1 to 807016c Compare June 24, 2024 04:48

jsoref requested a review from egilmorez June 24, 2024 04:48

egilmorez approved these changes Jun 28, 2024

View reviewed changes

MarkDuckworth approved these changes Jul 16, 2024

View reviewed changes

DellaBitta requested changes Jul 16, 2024

View reviewed changes

packages/auth-compat/CHANGELOG.md Show resolved Hide resolved

packages/app-compat/src/public-types.ts Show resolved Hide resolved

packages/auth/src/api/authentication/mfa.test.ts Show resolved Hide resolved

packages/performance/src/services/perf_logger.ts Outdated Show resolved Hide resolved

spelling: absolute

f36a4b3

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

jsoref added 19 commits July 16, 2024 11:31

spelling: timeout

97451c1

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: todo

956d550

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: trailing

3a1994c

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: transaction

ff76055

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: typescript

5a05ae8

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: unexpectedly

69070ef

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: unloaded

a09d032

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: users

df4d39f

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: variable

56b1922

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: verification

6f6d679

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: verifier

37f7066

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: version

5deb5c8

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: vomiting

c39c66f

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: whether the

23bae80

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: will

d329e57

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: with

761d57d

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: workspace

55f752c

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: wrapper

f45dfda

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: constructor [API]

0d192d1

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

jsoref force-pushed the spelling branch from 807016c to 0d192d1 Compare July 16, 2024 21:15

DellaBitta added 2 commits July 18, 2024 10:58

docs

7e68f0f

changeset

8433b90

DellaBitta requested a review from a team as a code owner July 18, 2024 15:07

DellaBitta approved these changes Jul 18, 2024

View reviewed changes

update changeset package list to represent code changes only.

eeb89cc

DellaBitta merged commit 025f2a1 into firebase:master Jul 18, 2024
36 of 39 checks passed

jsoref deleted the spelling branch July 18, 2024 21:19

tom-andersen pushed a commit that referenced this pull request Jul 24, 2024

Spelling (#8280)

0f96114

Numerous fixes to spelling across the SDK.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Spelling #8280

Spelling #8280

jsoref commented May 30, 2024 •

edited by DellaBitta

Loading

changeset-bot bot commented May 30, 2024 •

edited

Loading

jsoref May 30, 2024

jsoref May 30, 2024

jsoref May 30, 2024

jsoref May 30, 2024

MarkDuckworth Jul 16, 2024

jsoref Jul 16, 2024

jsoref May 30, 2024

jsoref May 30, 2024

egilmorez left a comment

jsoref commented Jun 24, 2024

egilmorez left a comment

jsoref commented Jun 28, 2024

MarkDuckworth left a comment

MarkDuckworth Jul 16, 2024

DellaBitta left a comment •

edited

Loading

jsoref commented Jul 16, 2024

DellaBitta commented Jul 18, 2024

Spelling #8280

Spelling #8280

Conversation

jsoref commented May 30, 2024 • edited by DellaBitta Loading

Discussion

Testing

API Changes

changeset-bot bot commented May 30, 2024 • edited Loading

🦋 Changeset detected

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

egilmorez left a comment

Choose a reason for hiding this comment

jsoref commented Jun 24, 2024

egilmorez left a comment

Choose a reason for hiding this comment

jsoref commented Jun 28, 2024

MarkDuckworth left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

DellaBitta left a comment • edited Loading

Choose a reason for hiding this comment

jsoref commented Jul 16, 2024

DellaBitta commented Jul 18, 2024

jsoref commented May 30, 2024 •

edited by DellaBitta

Loading

changeset-bot bot commented May 30, 2024 •

edited

Loading

DellaBitta left a comment •

edited

Loading