MLE-23505 : jsDoc for vector-util.js is missing #955
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR adds comprehensive JSDoc documentation to the vector-util.js module to address missing documentation. The module provides utility functions for encoding and decoding vectors in MarkLogic 12 or higher environments.
- Added namespace documentation for the vectorUtil module
- Added JSDoc for the base64Encode function that converts float arrays to encoded strings
- Added JSDoc for the base64Decode function that converts encoded strings back to float arrays
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
You can also share your feedback on Copilot code review for a chance to win a $100 gift card. Take the survey.
| * helps reduce the amount of disk space and memory consumed by vectors. | ||
| * @method vectorUtil#base64Encode | ||
| * @since 3.7.0 | ||
| * @param {float[]} vector - an array of float values |
There was a problem hiding this comment.
The type annotation 'float[]' is not valid JSDoc syntax. Use 'number[]' instead, as JavaScript uses the number type for all numeric values including floats.
| * @param {float[]} vector - an array of float values | |
| * @param {number[]} vector - an array of float values |
| * @method vectorUtil#base64Decode | ||
| * @since 3.7.0 | ||
| * @param {string} encodedVector - an encoded string value. | ||
| * @returns {float[]} an array of float values. |
There was a problem hiding this comment.
The type annotation 'float[]' is not valid JSDoc syntax. Use 'number[]' instead, as JavaScript uses the number type for all numeric values including floats.
| * @returns {float[]} an array of float values. | |
| * @returns {number[]} an array of float values. |
2 participants
No description provided.