Add comprehensive documentation to set commands #3642
+116
−2
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.
Add comprehensive documentation to set commands
Summary
This PR adds detailed documentation to all set command methods in
set_commands.goto improve developer experience and code discoverability.Changes
SetCmdableexplaining its purposeSAdd- Add members to a setSCard- Get set cardinalitySDiff- Set difference operationSDiffStore- Store set difference resultSInter- Set intersection operationSInterCard- Get intersection cardinalitySInterStore- Store set intersection resultSIsMember- Check membershipSMIsMember- Check multiple membershipsSMembers- Get all members (slice)SMembersMap- Get all members (map)SMove- Move member between setsSPop- Pop random memberSPopN- Pop multiple random membersSRandMember- Get random memberSRandMemberN- Get multiple random membersSRem- Remove membersSScan- Incrementally scan setSUnion- Set union operationSUnionStore- Store set union resultDocumentation Details
Each method now includes:
SScan)Benefits
SScanTesting