update the doc comments to TSDoc #392
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
hi, did you find some kind of linter, to ensure that our docs stay in the correct format? |
adanWattad
force-pushed
the
node/updateDoc
branch
from
e2287a0
to
ddd941c
Compare
|
@adanWattad did you check that the CI fails if there's an unformatted comment? |
adanWattad
force-pushed
the
node/updateDoc
branch
from
5891366
to
2869447
Compare
shachlanAmazon
approved these changes
Sep 3, 2023
acarbonetto
added a commit
that referenced
this pull request
Jul 1, 2024
* Java: Add XCLAIM command (#392) * Python: add XPENDING command (#1704) * Python: add XPENDING command * PR suggestions * PR suggestions * Java: Add Command GeoSearch & GeoSearchStore * Java: Add Command GeoSearch & GeoSearchStore --------- * trigger build * Python: add RANDOMKEY command (#1701) * Python: add RANDOMKEY command * Enable randomkey() test for that redis-rs is fixed Signed-off-by: Andrew Carbonetto <[email protected]> * NOP push Signed-off-by: Andrew Carbonetto <[email protected]> --------- Signed-off-by: Andrew Carbonetto <[email protected]> Co-authored-by: Andrew Carbonetto <[email protected]> * Python: add FUNCTION FLUSH command (#1700) * Python: Added FUNCTION LOAD command * Python: adds FUNCTION FLUSH command * Updated CHANGELOG.md * Resolved merge issues related to FlushMode * Minor adjustments on command documentation * Revert one minor change in example. --------- Co-authored-by: Shoham Elias <[email protected]> Co-authored-by: Andrew Carbonetto <[email protected]> * removing redis references * Java: Handle panics and errors in the Java FFI layer (#1601) * Restructure Java FFI layer to handle errors properly * Fix failing tests * Address clippy lints * Add tests for error and panic handling * Add missing errors module * Fix clippy lint * Fix FFI tests * Apply Spotless * Fix some minor issue I forgot about * Add some comments * Apply Spotless * Make handle_panics return Option<T> instead * Java: Add SSCAN and ZSCAN commands (#1705) * Java: Add `SSCAN` command (#394) * Add ScanOptions base class for scan-family options. * Expose the cursor as a String to support unsigned 64-bit cursor values. Co-authored-by: James Duong <[email protected]> * Java: Add `ZSCAN` command (#397) --------- Co-authored-by: James Duong <[email protected]> * WIP TODO: support transactions, docs, and more IT * Added more tests * Added tests and javadocs * Improved examples and tests * Correct use of SScanOptions instead of ScanOptions for SScan * Remove plumbing for SCAN command * Sleep after sadd() calls before sscan() calls Due to eventual consistency * Change sscan cursor to be a String Also fix bug in SharedCommandTests * WIP with todos * Add ZScan to TransactionTestUtilities * Spotless cleanup * Test fixes * Cleanup test code * Apply IntelliJ suggestions * Use String.valueOf() instead of concatenating empty string * Added better error info for set comparison failures * More logging for test failures * Add sleeps after zadd() calls To help make sure data is consistent without WAIT * Longer sleeps * Reduce wait time * Experiment with unsigned 64-bit cursors * Fix rebase error * WIP TODO: support transactions, docs, and more IT * Added more tests * Added tests and javadocs * Improved examples and tests * Apply PR comments * Fix method ordering in BaseTransaction * Fix broken line breaks within code tags in ScanOptions * More thoroughly test results in SharedCommandTests * Add better logging for set comparisons * Spotless * Sleep after sadd() calls before sscan() calls Due to eventual consistency * Change sscan cursor to be a String Also fix bug in SharedCommandTests * Update java/integTest/src/test/java/glide/SharedCommandTests.java Co-authored-by: Guian Gumpac <[email protected]> * Update java/integTest/src/test/java/glide/SharedCommandTests.java Co-authored-by: Guian Gumpac <[email protected]> * Fix rebase conflicts * Fix another rebase conflict * Spotless * Update java/client/src/main/java/glide/api/models/BaseTransaction.java Co-authored-by: Andrew Carbonetto <[email protected]> * Update java/client/src/main/java/glide/api/models/BaseTransaction.java Co-authored-by: Andrew Carbonetto <[email protected]> * Update java/client/src/main/java/glide/api/models/BaseTransaction.java Co-authored-by: Andrew Carbonetto <[email protected]> * Update java/client/src/main/java/glide/api/models/BaseTransaction.java Co-authored-by: Andrew Carbonetto <[email protected]> * Correctly use constants in TransactionTests * Rename ScanOptions to BaseScanOptions * Doc PR fixes * Treat end of cursor as failure * Spotless * Fixes * Update java/client/src/main/java/glide/api/commands/SortedSetBaseCommands.java Co-authored-by: Andrew Carbonetto <[email protected]> * Update java/client/src/main/java/glide/api/commands/SortedSetBaseCommands.java Co-authored-by: Andrew Carbonetto <[email protected]> * Update java/client/src/main/java/glide/api/commands/SortedSetBaseCommands.java Co-authored-by: Andrew Carbonetto <[email protected]> * Update java/client/src/main/java/glide/api/commands/SortedSetBaseCommands.java Co-authored-by: Andrew Carbonetto <[email protected]> * Minor doc changes --------- Co-authored-by: Guian Gumpac <[email protected]> Co-authored-by: Andrew Carbonetto <[email protected]> * CI: Add Support for Valkey 6.2, 7.0 and 7.2 (#1711) - Transitioned the engine building process to be sourced from the Valkey repository. - Introduced compatibility with the following engine versions: Valkey and Redis 6.2 Valkey and Redis 7.0 Valkey and Redis 7.2 (first stable release of Valkey 7.2.5.) - Engine Installation Checks: Added check that the engine is installed with the requested version. - Moved the engine version matrix to a JSON file for better management and readability. - Fixed Object Encoding tests to expect quicklist on versions < 7.2 instead of 7.0 - Fixed C# and Java version parsing from redis-server -v output to support also Valkey's output - Updated the README file with the supported versions & engine typ * Python: add FUNCTION DELETE command (#1714) * Python: adds FUNCTION DELETE command Co-authored-by: Shoham Elias <[email protected]> * Python: add `SSCAN` command (#1709) * Added sscan command to python * Fixed formatting * Fixed CI failures * Lint * Improved example and test * Changes based on sscan java PR * Added to changelog * Addressed PR comments * Added string casting * Java: Add HSCAN command (#1706) * Java: Add `SSCAN` command (#394) * Add ScanOptions base class for scan-family options. * Expose the cursor as a String to support unsigned 64-bit cursor values. Co-authored-by: James Duong <[email protected]> * Java: Add `ZSCAN` command (#397) --------- Co-authored-by: James Duong <[email protected]> * WIP TODO: support transactions, docs, and more IT * Added more tests * Added tests and javadocs * Improved examples and tests * Correct use of SScanOptions instead of ScanOptions for SScan * Remove plumbing for SCAN command * Sleep after sadd() calls before sscan() calls Due to eventual consistency * Change sscan cursor to be a String Also fix bug in SharedCommandTests * WIP with todos * Add ZScan to TransactionTestUtilities * Spotless cleanup * Test fixes * Cleanup test code * Apply IntelliJ suggestions * Use String.valueOf() instead of concatenating empty string * Added better error info for set comparison failures * More logging for test failures * Add sleeps after zadd() calls To help make sure data is consistent without WAIT * Longer sleeps * Reduce wait time * Experiment with unsigned 64-bit cursors * Fix rebase error * WIP TODO: support transactions, docs, and more IT * Added more tests * Added tests and javadocs * Improved examples and tests * Sleep after sadd() calls before sscan() calls Due to eventual consistency * Change sscan cursor to be a String Also fix bug in SharedCommandTests * Fix rebase conflicts * Fix another rebase conflict * Spotless * HScan * Flakey test * Add HScan transaction unit test * Rename ScanOptions to BaseScanOptions * Fix merge issues * Fix module-info ordering * Tidy up docs * PR comments Fix up merge duplication and use HScanOptions constants. --------- Co-authored-by: Guian Gumpac <[email protected]> * Python: add LCS command (#1716) * python: add LCS command (#406) * python: add LCS command * update CHANGELOG * add more comment explaning the functionality of the command * address comments on the docs * Java: Changed handling of large requests to transfer them as leaked pointers (#1708) * Restructure Java FFI layer to handle errors properly * Address clippy lints * Add tests for error and panic handling * Fix FFI tests * Apply Spotless * Fix some minor issue I forgot about * Add API to create the leaked bytes vec * Bridge the MAX_REQUEST_ARGS_LENGTH constant from Rust to Java * Fix warnings in Rust * Update Java client to utilize the pointer with large argument sizes * Update createLeakedBytesVec to handle panics * spotless * Add docs and run Rust linters * Add large value tests * Fix transactions and add transaction tests * dummy commit for CI * Revert "dummy commit for CI" This reverts commit 3ed1937. * Fix JDK11 build issue Due to using a JDK17 function * Fix another JDK11 issue * Fix merge issues. * Remove unneccesary mut prefix * Clarify the MAX_REQUEST_ARGS_LENGTH_IN_BYTES constant * Fix merge issue --------- Co-authored-by: Jonathan Louie <[email protected]> * Create initial workflow for publishing to Maven Central (#1600) * WIP Create initial workflow for publishing to Maven Central (#1594) * WIP Create initial workflow for publishing to Maven Central * Add classifier to workflow * Remove condition to allow all jobs to run * Try to fix Gradle workflow errors * Re-enable aws related options * Add missing property * Revert "Add missing property" This reverts commit 6cc5fba. * Add AWS_ACTIONS option * Sign JAR file * Fix signing issue * Try to fix issue with generating secring.gpg file * Fix path to secring.gpg * Try to fix secring.gpg retrieval issue * Remove base64 decode * Try to fix multi-line issue with GPG key secret * Go back to echo approach * Decode base64 properly this time * Use GPG_KEY_ID * Surround password in quotes * Publish JAR to local Maven and upload * Update examples build.gradle * Sign publishToMavenLocal build * Update version of Java JAR * Properly fetch src_folder variable contents * Reorganize JAR contents * Update path of uploaded JAR * Update artifact ID * Add missing comma * Replace placeholders in build.gradle * Update examples build.gradle * Remove test runs from java.yml workflow * Add debugging info to workflow * Adjust debug info * Readd placeholder text in build.gradle * Add more debug info * Change how the JAR is copied * Add configurations for ARM linux and x86 macos * Prevent output artifacts from being swallowed * Update build matrix to use proper RUNNERs * Try to use self-hosted runner for ARM Linux builds * Delete gradle-cd workflow * Add id-token permissions * Add step to setup self-hosted runner access * Add CONTAINER property to java.yml workflow * Remove install Redis step from java.yml workflow * Remove test-benchmark step from java.yml workflow * Fix issue with Java classifier * Update java.yml to use classifier * Bump version and add archiveClassifier * Change groupId to valkey-client * Update example and base archive name * Update workflow * Rename to glide-for-redis * Extracting Java Deployment to a different workflow Workflow will only trigger when a tag is pushed to the repo Version is extracted from the tag and replaced in the build.grade files reverted changes of java.yml file * trying to make the workflow to build * testing action to prepare build * forcing new action to trigger * Revert "forcing new action to trigger" This reverts commit d097a1f. * Revert "testing action to prepare build" This reverts commit 8864434. * Revert "trying to make the workflow to build" This reverts commit 143818a. * Revert "Extracting Java Deployment to a different workflow" This reverts commit faff846. * Revert "Revert "Extracting Java Deployment to a different workflow"" This reverts commit 11f8470. * fixing workflow * fixed path for the local maven * removing bundle from the tests fix to the JAVA CI not finding tests dependencies * fix java workflow * removing classifier from the pom * fixing concurrency * Remove publishToMavenLocal line in examples build.gradle * fix examples * cleaning up java.yml * testing removing test dependency * adding skip signing * Revert "adding skip signing" This reverts commit e448788. * Revert "testing removing test dependency" This reverts commit d0e06b7. * Revert "cleaning up java.yml" This reverts commit e7394d7. * removing dependency of singing in the local build * java.yml clean up * removing steps from java.yml * added comments * removed step on sed the examples and removed if always from the upload artifacts --------- Co-authored-by: affonsov <[email protected]> Co-authored-by: affonsov <[email protected]> * #1715: fix flakey test in xpending (#1717) Signed-off-by: Andrew Carbonetto <[email protected]> * Java: Adding command WAIT (#1707) * Java: Adding command WAIT Java: Adding command WAIT * addressing comments * fixing timeout_idx in get_timeout_from_cmd_args call * update timeout check * fixing rust test * adding special case for WAIT * rust linter * remove special case in get_timeout_from_cmd_args * adding description for timeout 0 * rust linter * updating timeout test * changing transaction documentation --------- Co-authored-by: TJ Zhang <[email protected]> * support smismember with GlideString (#1694) * Support GlideString for sdiff commands (#1722) Co-authored-by: Yulazari <[email protected]> * Updated attribution files * support hset, hget, lindex, linsert, blmove, incr, hlen and lmove wit… (#1667) * Python: move the commands return value to bytes (#1617) * In the case of Simple String, Bulk String, or Verbatim String commands, Bytes will be returned instead of strings. --------- Co-authored-by: GilboaAWS <[email protected]> Co-authored-by: Ubuntu <[email protected]> Co-authored-by: Adar Ovadia <[email protected]> Co-authored-by: Shoham Elias <[email protected]> Co-authored-by: Shoham Elias <[email protected]> * Java: Add XGROUP SETID command (#1720) * Initial implementation of XGroupSetId * Unit tests * Add integration tests * PR feedback * Address PR comments doc updates * Add 7.0.0 transaction integration test * Java: update README directory to include Java's README.md (#1734) add java part to readme directory * Java: Add XCLAIM command Signed-off-by: Andrew Carbonetto <[email protected]> * Add unit tests Signed-off-by: Andrew Carbonetto <[email protected]> * Add transaction tests Signed-off-by: Andrew Carbonetto <[email protected]> * SPOTLESS Signed-off-by: Andrew Carbonetto <[email protected]> * Update IT tests Signed-off-by: Andrew Carbonetto <[email protected]> * Update IT tests Signed-off-by: Andrew Carbonetto <[email protected]> * Add UT tests Signed-off-by: Andrew Carbonetto <[email protected]> * Add transaction tests Signed-off-by: Andrew Carbonetto <[email protected]> * Fix transaction tests Signed-off-by: Andrew Carbonetto <[email protected]> * Update XCLAIM with options; remove LASTID Signed-off-by: Andrew Carbonetto <[email protected]> * Add a couple more test cases Signed-off-by: Andrew Carbonetto <[email protected]> * clean up Signed-off-by: Andrew Carbonetto <[email protected]> * Clean rust Signed-off-by: Andrew Carbonetto <[email protected]> * Add examples Signed-off-by: Andrew Carbonetto <[email protected]> * Move to 2D string array in response Signed-off-by: Andrew Carbonetto <[email protected]> * Fix Transaction tests; update examples Signed-off-by: Andrew Carbonetto <[email protected]> * SPOTLESS Signed-off-by: Andrew Carbonetto <[email protected]> --------- Signed-off-by: Andrew Carbonetto <[email protected]> Co-authored-by: Aaron <[email protected]> Co-authored-by: tjzhang-BQ <[email protected]> Co-authored-by: TJ Zhang <[email protected]> Co-authored-by: Yi-Pin Chen <[email protected]> Co-authored-by: Shoham Elias <[email protected]> Co-authored-by: jonathanl-bq <[email protected]> Co-authored-by: James Duong <[email protected]> Co-authored-by: Guian Gumpac <[email protected]> Co-authored-by: Bar Shaul <[email protected]> Co-authored-by: James Duong <[email protected]> Co-authored-by: James Xin <[email protected]> Co-authored-by: Jonathan Louie <[email protected]> Co-authored-by: affonsov <[email protected]> Co-authored-by: affonsov <[email protected]> Co-authored-by: Alon Arenberg <[email protected]> Co-authored-by: yulazariy <[email protected]> Co-authored-by: Yulazari <[email protected]> Co-authored-by: ort-bot <[email protected]> Co-authored-by: adarovadya <[email protected]> Co-authored-by: GilboaAWS <[email protected]> Co-authored-by: Ubuntu <[email protected]> Co-authored-by: Adar Ovadia <[email protected]> Co-authored-by: Shoham Elias <[email protected]> Co-authored-by: Chloe Yip <[email protected]> * SPOTLESS Signed-off-by: Andrew Carbonetto <[email protected]> * Fix merge conflicts Signed-off-by: Andrew Carbonetto <[email protected]> * Review comments Signed-off-by: Andrew Carbonetto <[email protected]> * Update docs for review comments Signed-off-by: Andrew Carbonetto <[email protected]> * small doc fix Signed-off-by: Andrew Carbonetto <[email protected]> --------- Signed-off-by: Andrew Carbonetto <[email protected]> Co-authored-by: Aaron <[email protected]> Co-authored-by: tjzhang-BQ <[email protected]> Co-authored-by: TJ Zhang <[email protected]> Co-authored-by: Yi-Pin Chen <[email protected]> Co-authored-by: Shoham Elias <[email protected]> Co-authored-by: jonathanl-bq <[email protected]> Co-authored-by: James Duong <[email protected]> Co-authored-by: Guian Gumpac <[email protected]> Co-authored-by: Bar Shaul <[email protected]> Co-authored-by: James Duong <[email protected]> Co-authored-by: James Xin <[email protected]> Co-authored-by: Jonathan Louie <[email protected]> Co-authored-by: affonsov <[email protected]> Co-authored-by: affonsov <[email protected]> Co-authored-by: Alon Arenberg <[email protected]> Co-authored-by: yulazariy <[email protected]> Co-authored-by: Yulazari <[email protected]> Co-authored-by: ort-bot <[email protected]> Co-authored-by: adarovadya <[email protected]> Co-authored-by: GilboaAWS <[email protected]> Co-authored-by: Ubuntu <[email protected]> Co-authored-by: Adar Ovadia <[email protected]> Co-authored-by: Shoham Elias <[email protected]> Co-authored-by: Chloe Yip <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
update the doc comments to TSDoc.