Skip to content

Fix vectorvalue docs #8453

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

Merged
merged 3 commits into from
Feb 19, 2025
Merged

Fix vectorvalue docs #8453

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f10a334
Fix vectorvalue docs
dlarocque Aug 22, 2024
ccaa0b6
Use @link vector
dlarocque Sep 9, 2024
d39a66c
Fix vector link with code tag
dlarocque Oct 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs-devsite/firestore_.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,7 @@ https://github.com/firebase/firebase-js-sdk
| [SnapshotMetadata](./firestore_.snapshotmetadata.md#snapshotmetadata_class) | Metadata about a snapshot, describing the state of the snapshot. |
| [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)<!-- -->. |
| [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)<!-- -->. |
| [VectorValue](./firestore_.vectorvalue.md#vectorvalue_class) | Represents a vector type in Firestore documents. Create an instance with . VectorValue |
| [VectorValue](./firestore_.vectorvalue.md#vectorvalue_class) | Represents a vector type in Firestore documents. Create an instance with <code>{@link vector}</code>. VectorValue |
| [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. |

## Interfaces
Expand Down
6 changes: 3 additions & 3 deletions docs-devsite/firestore_.vectorvalue.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ https://github.com/firebase/firebase-js-sdk
{% endcomment %}

# VectorValue class
Represents a vector type in Firestore documents. Create an instance with .
Represents a vector type in Firestore documents. Create an instance with `{@link vector}`<!-- -->.

VectorValue

Expand All @@ -24,12 +24,12 @@ export declare class VectorValue

| Method | Modifiers | Description |
| --- | --- | --- |
| [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. |
| [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. |
| [toArray()](./firestore_.vectorvalue.md#vectorvaluetoarray) | | Returns a copy of the raw number array form of the vector. |

## VectorValue.isEqual()

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

<b>Signature:</b>

Expand Down
2 changes: 1 addition & 1 deletion docs-devsite/firestore_lite.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ https://github.com/firebase/firebase-js-sdk
| [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>. |
| [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)<!-- -->. |
| [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)<!-- -->. |
| [VectorValue](./firestore_lite.vectorvalue.md#vectorvalue_class) | Represents a vector type in Firestore documents. Create an instance with . VectorValue |
| [VectorValue](./firestore_lite.vectorvalue.md#vectorvalue_class) | Represents a vector type in Firestore documents. Create an instance with <code>{@link vector}</code>. VectorValue |
| [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. |

## Interfaces
Expand Down
6 changes: 3 additions & 3 deletions docs-devsite/firestore_lite.vectorvalue.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ https://github.com/firebase/firebase-js-sdk
{% endcomment %}

# VectorValue class
Represents a vector type in Firestore documents. Create an instance with .
Represents a vector type in Firestore documents. Create an instance with `{@link vector}`<!-- -->.

VectorValue

Expand All @@ -24,12 +24,12 @@ export declare class VectorValue

| Method | Modifiers | Description |
| --- | --- | --- |
| [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. |
| [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. |
| [toArray()](./firestore_lite.vectorvalue.md#vectorvaluetoarray) | | Returns a copy of the raw number array form of the vector. |

## VectorValue.isEqual()

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

<b>Signature:</b>

Expand Down
4 changes: 2 additions & 2 deletions packages/firestore/src/lite-api/vector_value.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ import { isPrimitiveArrayEqual } from '../util/array';

/**
* Represents a vector type in Firestore documents.
* Create an instance with {@link FieldValue.vector}.
* Create an instance with `{@link vector}`.
Copy link
Contributor

Choose a reason for hiding this comment

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

I don't think this is right, there shouldn't be backticks? If you use the correct format, the resulting markdown files shouldn't have the word "@link" in them anymore, it should be a markdown link (brackets then parens)

Copy link
Contributor

Choose a reason for hiding this comment

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

By the way, this is the way to have something that is both a link and code formatted - you have to use the code tags here in the comment, you can't use backticks:

<code>{@link vector}</code>

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I wrapped this in <code></code> in my latest commit and it has applied both link and code formatting, but I'm not sure if the link itself is correct. When I click it, it doesn't redirect me to the vector() function in the docs. Is this expected?

Copy link
Contributor

Choose a reason for hiding this comment

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

I think it should work, it comes out the same with or without the <code> tags and a lot of other existing functions seem to have the same format. In any case it's an improvement as it's not a empty space so let's try.

*
* @class VectorValue
*/
Expand All @@ -43,7 +43,7 @@ export class VectorValue {
}

/**
* Returns `true` if the two VectorValue has the same raw number arrays, returns `false` otherwise.
* Returns `true` if the two `VectorValue` values have the same raw number arrays, returns `false` otherwise.
*/
isEqual(other: VectorValue): boolean {
return isPrimitiveArrayEqual(this._values, other._values);
Expand Down
Loading