Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 950765e

Browse files
nicolasffnicolasff
committed
Documentation fix.
Addresses GitHub issue phpredis#169.
1 parent c265627 commit 950765e

File tree

1 file changed

+32
-32
lines changed

1 file changed

+32
-32
lines changed

‎README.markdown

Lines changed: 32 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -774,9 +774,9 @@ Adds a value to the set value stored at key. If this value is already in the set
774774
*BOOL* `TRUE` if value didn't exist and was added successfully, `FALSE` if the value is already present.
775775
##### *Example*
776776
<pre>
777-
$redis->sAdd('key1' , 'set1'); /* TRUE, 'key1' => {'set1'} */
778-
$redis->sAdd('key1' , 'set2'); /* TRUE, 'key1' => {'set1', 'set2'}*/
779-
$redis->sAdd('key1' , 'set2'); /* FALSE, 'key1' => {'set1', 'set2'}*/
777+
$redis->sAdd('key1' , 'member1'); /* TRUE, 'key1' => {'member1'} */
778+
$redis->sAdd('key1' , 'member2'); /* TRUE, 'key1' => {'member1', 'member2'}*/
779+
$redis->sAdd('key1' , 'member2'); /* FALSE, 'key1' => {'member1', 'member2'}*/
780780
</pre>
781781

782782
## sRem, sRemove
@@ -789,10 +789,10 @@ Removes the specified member from the set value stored at key.
789789
*BOOL* `TRUE` if the member was present in the set, `FALSE` if it didn't.
790790
##### *Example*
791791
<pre>
792-
$redis->sAdd('key1' , 'set1');
793-
$redis->sAdd('key1' , 'set2');
794-
$redis->sAdd('key1' , 'set3'); /* 'key1' => {'set1', 'set2', 'set3'}*/
795-
$redis->sRem('key1', 'set2'); /* 'key1' => {'set1', 'set3'} */
792+
$redis->sAdd('key1' , 'member1');
793+
$redis->sAdd('key1' , 'member2');
794+
$redis->sAdd('key1' , 'member3'); /* 'key1' => {'member1', 'member2', 'member3'}*/
795+
$redis->sRem('key1', 'member2'); /* 'key1' => {'member1', 'member3'} */
796796
</pre>
797797

798798
## sMove
@@ -806,13 +806,13 @@ Moves the specified member from the set at srcKey to the set at dstKey.
806806
*BOOL* If the operation is successful, return `TRUE`. If the srcKey and/or dstKey didn't exist, and/or the member didn't exist in srcKey, `FALSE` is returned.
807807
##### *Example*
808808
<pre>
809-
$redis->sAdd('key1' , 'set11');
810-
$redis->sAdd('key1' , 'set12');
811-
$redis->sAdd('key1' , 'set13'); /* 'key1' => {'set11', 'set12', 'set13'}*/
812-
$redis->sAdd('key2' , 'set21');
813-
$redis->sAdd('key2' , 'set22'); /* 'key2' => {'set21', 'set22'}*/
814-
$redis->sMove('key1', 'key2', 'set13'); /* 'key1' => {'set11', 'set12'} */
815-
/* 'key2' => {'set21', 'set22', 'set13'} */
809+
$redis->sAdd('key1' , 'member11');
810+
$redis->sAdd('key1' , 'member12');
811+
$redis->sAdd('key1' , 'member13'); /* 'key1' => {'member11', 'member12', 'member13'}*/
812+
$redis->sAdd('key2' , 'member21');
813+
$redis->sAdd('key2' , 'member22'); /* 'key2' => {'member21', 'member22'}*/
814+
$redis->sMove('key1', 'key2', 'member13'); /* 'key1' => {'member11', 'member12'} */
815+
/* 'key2' => {'member21', 'member22', 'member13'} */
816816

817817
</pre>
818818

@@ -827,12 +827,12 @@ Checks if `value` is a member of the set stored at the key `key`.
827827
*BOOL* `TRUE` if `value` is a member of the set at key `key`, `FALSE` otherwise.
828828
##### *Example*
829829
<pre>
830-
$redis->sAdd('key1' , 'set1');
831-
$redis->sAdd('key1' , 'set2');
832-
$redis->sAdd('key1' , 'set3'); /* 'key1' => {'set1', 'set2', 'set3'}*/
830+
$redis->sAdd('key1' , 'member1');
831+
$redis->sAdd('key1' , 'member2');
832+
$redis->sAdd('key1' , 'member3'); /* 'key1' => {'member1', 'member2', 'member3'}*/
833833

834-
$redis->sIsMember('key1', 'set1'); /* TRUE */
835-
$redis->sIsMember('key1', 'setX'); /* FALSE */
834+
$redis->sIsMember('key1', 'member1'); /* TRUE */
835+
$redis->sIsMember('key1', 'memberX'); /* FALSE */
836836

837837
</pre>
838838

@@ -845,9 +845,9 @@ Returns the cardinality of the set identified by key.
845845
*LONG* the cardinality of the set identified by key, 0 if the set doesn't exist.
846846
##### *Example*
847847
<pre>
848-
$redis->sAdd('key1' , 'set1');
849-
$redis->sAdd('key1' , 'set2');
850-
$redis->sAdd('key1' , 'set3'); /* 'key1' => {'set1', 'set2', 'set3'}*/
848+
$redis->sAdd('key1' , 'member1');
849+
$redis->sAdd('key1' , 'member2');
850+
$redis->sAdd('key1' , 'member3'); /* 'key1' => {'member1', 'member2', 'member3'}*/
851851
$redis->sCard('key1'); /* 3 */
852852
$redis->sCard('keyX'); /* 0 */
853853
</pre>
@@ -862,11 +862,11 @@ Removes and returns a random element from the set value at Key.
862862
*Bool* `FALSE` if set identified by key is empty or doesn't exist.
863863
##### *Example*
864864
<pre>
865-
$redis->sAdd('key1' , 'set1');
866-
$redis->sAdd('key1' , 'set2');
867-
$redis->sAdd('key1' , 'set3'); /* 'key1' => {'set3', 'set1', 'set2'}*/
868-
$redis->sPop('key1'); /* 'set1', 'key1' => {'set3', 'set2'} */
869-
$redis->sPop('key1'); /* 'set3', 'key1' => {'set2'} */
865+
$redis->sAdd('key1' , 'member1');
866+
$redis->sAdd('key1' , 'member2');
867+
$redis->sAdd('key1' , 'member3'); /* 'key1' => {'member3', 'member1', 'member2'}*/
868+
$redis->sPop('key1'); /* 'member1', 'key1' => {'member3', 'member2'} */
869+
$redis->sPop('key1'); /* 'member3', 'key1' => {'member2'} */
870870
</pre>
871871

872872
## sRandMember
@@ -879,11 +879,11 @@ Returns a random element from the set value at Key, without removing it.
879879
*Bool* `FALSE` if set identified by key is empty or doesn't exist.
880880
##### *Example*
881881
<pre>
882-
$redis->sAdd('key1' , 'set1');
883-
$redis->sAdd('key1' , 'set2');
884-
$redis->sAdd('key1' , 'set3'); /* 'key1' => {'set3', 'set1', 'set2'}*/
885-
$redis->sRandMember('key1'); /* 'set1', 'key1' => {'set3', 'set1', 'set2'} */
886-
$redis->sRandMember('key1'); /* 'set3', 'key1' => {'set3', 'set1', 'set2'} */
882+
$redis->sAdd('key1' , 'member1');
883+
$redis->sAdd('key1' , 'member2');
884+
$redis->sAdd('key1' , 'member3'); /* 'key1' => {'member3', 'member1', 'member2'}*/
885+
$redis->sRandMember('key1'); /* 'member1', 'key1' => {'member3', 'member1', 'member2'} */
886+
$redis->sRandMember('key1'); /* 'member3', 'key1' => {'member3', 'member1', 'member2'} */
887887
</pre>
888888

889889
## sInter

0 commit comments

Comments
 (0)