-
Notifications
You must be signed in to change notification settings - Fork 892
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.
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
Fix vectorvalue docs #8453
base: main
Are you sure you want to change the base?
Fix vectorvalue docs #8453
Conversation
|
Size Report 1Affected Products
Test Logs |
Size Analysis Report 1This report is too large (1,243,472 characters) to be displayed here in a GitHub comment. Please use the below link to see the full report on Google Cloud Storage.Test Logs |
@@ -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 `VectorValue.fromArray(array)`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think the correct link should be {@link vector}
? I think when we moved from compat to modular, we took a lot of symbols that used to be on the FieldValue
namespace (serverTimestamp, arrayUnion, etc) and moved them to top level exports and this fits the pattern. @MarkDuckworth - confirm?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is correct. Good catch @hsubox76. May be copy-pasta or just a mix up when moving between Firestore SDK.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks! LG from a doc string perspective.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we need to make the change @hsubox76 suggested. Otherwise this is good. Thank you for helping clean this 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 `VectorValue.fromArray(array)`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is correct. Good catch @hsubox76. May be copy-pasta or just a mix up when moving between Firestore SDK.
@@ -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}`. |
There was a problem hiding this comment.
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)
There was a problem hiding this comment.
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>
There was a problem hiding this comment.
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?
In response to comments in cl/665934159