Skip to content

Commit 604133f

Browse files
authored
Fix vectorvalue docs (#8453)
* Fix vectorvalue docs * Use @link vector * Fix vector link with code tag
1 parent 84dfeca commit 604133f

File tree

5 files changed

+10
-10
lines changed

5 files changed

+10
-10
lines changed

docs-devsite/firestore_.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -157,7 +157,7 @@ https://github.com/firebase/firebase-js-sdk
157157
| [SnapshotMetadata](./firestore_.snapshotmetadata.md#snapshotmetadata_class) | Metadata about a snapshot, describing the state of the snapshot. |
158158
| [Timestamp](./firestore_.timestamp.md#timestamp_class) | A <code>Timestamp</code> represents a point in time independent of any time zone or calendar, represented as seconds and fractions of seconds at nanosecond resolution in UTC Epoch time.<!-- -->It is encoded using the Proleptic Gregorian Calendar which extends the Gregorian calendar backwards to year one. It is encoded assuming all minutes are 60 seconds long, i.e. leap seconds are "smeared" so that no leap second table is needed for interpretation. Range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z.<!-- -->For examples and further specifications, refer to the [Timestamp definition](https://github.com/google/protobuf/blob/master/src/google/protobuf/timestamp.proto)<!-- -->. |
159159
| [Transaction](./firestore_.transaction.md#transaction_class) | A reference to a transaction.<!-- -->The <code>Transaction</code> object passed to a transaction's <code>updateFunction</code> provides the methods to read and write data within the transaction context. See [runTransaction()](./firestore_.md#runtransaction_6f03ec4)<!-- -->. |
160-
| [VectorValue](./firestore_.vectorvalue.md#vectorvalue_class) | Represents a vector type in Firestore documents. Create an instance with . VectorValue |
160+
| [VectorValue](./firestore_.vectorvalue.md#vectorvalue_class) | Represents a vector type in Firestore documents. Create an instance with <code>[vector()](./firestore_.md#vector_0dbdaf2)</code>. VectorValue |
161161
| [WriteBatch](./firestore_.writebatch.md#writebatch_class) | A write batch, used to perform multiple writes as a single atomic unit.<!-- -->A <code>WriteBatch</code> object can be acquired by calling [writeBatch()](./firestore_.md#writebatch_231a8e0)<!-- -->. It provides methods for adding writes to the write batch. None of the writes will be committed (or visible locally) until [WriteBatch.commit()](./firestore_.writebatch.md#writebatchcommit) is called. |
162162

163163
## Interfaces

docs-devsite/firestore_.vectorvalue.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ https://github.com/firebase/firebase-js-sdk
1010
{% endcomment %}
1111

1212
# VectorValue class
13-
Represents a vector type in Firestore documents. Create an instance with .
13+
Represents a vector type in Firestore documents. Create an instance with <code>[vector()](./firestore_.md#vector_0dbdaf2)</code>.
1414

1515
VectorValue
1616

@@ -24,12 +24,12 @@ export declare class VectorValue
2424

2525
| Method | Modifiers | Description |
2626
| --- | --- | --- |
27-
| [isEqual(other)](./firestore_.vectorvalue.md#vectorvalueisequal) | | Returns <code>true</code> if the two VectorValue has the same raw number arrays, returns <code>false</code> otherwise. |
27+
| [isEqual(other)](./firestore_.vectorvalue.md#vectorvalueisequal) | | Returns <code>true</code> if the two <code>VectorValue</code> values have the same raw number arrays, returns <code>false</code> otherwise. |
2828
| [toArray()](./firestore_.vectorvalue.md#vectorvaluetoarray) | | Returns a copy of the raw number array form of the vector. |
2929

3030
## VectorValue.isEqual()
3131

32-
Returns `true` if the two VectorValue has the same raw number arrays, returns `false` otherwise.
32+
Returns `true` if the two `VectorValue` values have the same raw number arrays, returns `false` otherwise.
3333

3434
<b>Signature:</b>
3535

docs-devsite/firestore_lite.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ https://github.com/firebase/firebase-js-sdk
119119
| [QueryStartAtConstraint](./firestore_lite.querystartatconstraint.md#querystartatconstraint_class) | A <code>QueryStartAtConstraint</code> is used to exclude documents from the start of a result set returned by a Firestore query. <code>QueryStartAtConstraint</code>s are created by invoking [startAt()](./firestore_.md#startat_9a4477f) or [startAfter()](./firestore_.md#startafter_9a4477f) and can then be passed to [query()](./firestore_.md#query_9f7b0f4) to create a new query instance that also contains this <code>QueryStartAtConstraint</code>. |
120120
| [Timestamp](./firestore_lite.timestamp.md#timestamp_class) | A <code>Timestamp</code> represents a point in time independent of any time zone or calendar, represented as seconds and fractions of seconds at nanosecond resolution in UTC Epoch time.<!-- -->It is encoded using the Proleptic Gregorian Calendar which extends the Gregorian calendar backwards to year one. It is encoded assuming all minutes are 60 seconds long, i.e. leap seconds are "smeared" so that no leap second table is needed for interpretation. Range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z.<!-- -->For examples and further specifications, refer to the [Timestamp definition](https://github.com/google/protobuf/blob/master/src/google/protobuf/timestamp.proto)<!-- -->. |
121121
| [Transaction](./firestore_lite.transaction.md#transaction_class) | A reference to a transaction.<!-- -->The <code>Transaction</code> object passed to a transaction's <code>updateFunction</code> provides the methods to read and write data within the transaction context. See [runTransaction()](./firestore_.md#runtransaction_6f03ec4)<!-- -->. |
122-
| [VectorValue](./firestore_lite.vectorvalue.md#vectorvalue_class) | Represents a vector type in Firestore documents. Create an instance with . VectorValue |
122+
| [VectorValue](./firestore_lite.vectorvalue.md#vectorvalue_class) | Represents a vector type in Firestore documents. Create an instance with <code>[vector()](./firestore_.md#vector_0dbdaf2)</code>. VectorValue |
123123
| [WriteBatch](./firestore_lite.writebatch.md#writebatch_class) | A write batch, used to perform multiple writes as a single atomic unit.<!-- -->A <code>WriteBatch</code> object can be acquired by calling [writeBatch()](./firestore_.md#writebatch_231a8e0)<!-- -->. It provides methods for adding writes to the write batch. None of the writes will be committed (or visible locally) until [WriteBatch.commit()](./firestore_.writebatch.md#writebatchcommit) is called. |
124124

125125
## Interfaces

docs-devsite/firestore_lite.vectorvalue.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ https://github.com/firebase/firebase-js-sdk
1010
{% endcomment %}
1111

1212
# VectorValue class
13-
Represents a vector type in Firestore documents. Create an instance with .
13+
Represents a vector type in Firestore documents. Create an instance with <code>[vector()](./firestore_.md#vector_0dbdaf2)</code>.
1414

1515
VectorValue
1616

@@ -24,12 +24,12 @@ export declare class VectorValue
2424

2525
| Method | Modifiers | Description |
2626
| --- | --- | --- |
27-
| [isEqual(other)](./firestore_lite.vectorvalue.md#vectorvalueisequal) | | Returns <code>true</code> if the two VectorValue has the same raw number arrays, returns <code>false</code> otherwise. |
27+
| [isEqual(other)](./firestore_lite.vectorvalue.md#vectorvalueisequal) | | Returns <code>true</code> if the two <code>VectorValue</code> values have the same raw number arrays, returns <code>false</code> otherwise. |
2828
| [toArray()](./firestore_lite.vectorvalue.md#vectorvaluetoarray) | | Returns a copy of the raw number array form of the vector. |
2929

3030
## VectorValue.isEqual()
3131

32-
Returns `true` if the two VectorValue has the same raw number arrays, returns `false` otherwise.
32+
Returns `true` if the two `VectorValue` values have the same raw number arrays, returns `false` otherwise.
3333

3434
<b>Signature:</b>
3535

packages/firestore/src/lite-api/vector_value.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ import { isPrimitiveArrayEqual } from '../util/array';
1919

2020
/**
2121
* Represents a vector type in Firestore documents.
22-
* Create an instance with {@link FieldValue.vector}.
22+
* Create an instance with <code>{@link vector}</code>.
2323
*
2424
* @class VectorValue
2525
*/
@@ -43,7 +43,7 @@ export class VectorValue {
4343
}
4444

4545
/**
46-
* Returns `true` if the two VectorValue has the same raw number arrays, returns `false` otherwise.
46+
* Returns `true` if the two `VectorValue` values have the same raw number arrays, returns `false` otherwise.
4747
*/
4848
isEqual(other: VectorValue): boolean {
4949
return isPrimitiveArrayEqual(this._values, other._values);

0 commit comments

Comments
 (0)