Unverified Commit 7c3916ae authored by Wen Hui's avatar Wen Hui Committed by GitHub
Browse files

Fix command GEOHASH and GEOPOS argument doc, mark member as optional (#11417)

These commands take a list of members, which can be empty (i.e. running
the command with just a key name).
this always results in an empty array reply, so it doesn't make much sense,
but changing it is a breaking change.

This PR fixes the documentation, making the member field as optional, just makes
sure the command format documentation is consistent with the command behavior.

The command format will be:

127.0.0.1:6381> GEOPOS key [member [member ...]]
127.0.0.1:6381> GEOHASH key [member [member ...]]
parent f8970fdb
......@@ -1872,7 +1872,7 @@ struct redisCommandArg GEODIST_Args[] = {
/* GEOHASH argument table */
struct redisCommandArg GEOHASH_Args[] = {
{"key",ARG_TYPE_KEY,0,NULL,NULL,NULL,CMD_ARG_NONE},
{"member",ARG_TYPE_STRING,-1,NULL,NULL,NULL,CMD_ARG_MULTIPLE},
{"member",ARG_TYPE_STRING,-1,NULL,NULL,NULL,CMD_ARG_OPTIONAL|CMD_ARG_MULTIPLE},
{0}
};
......@@ -1887,7 +1887,7 @@ struct redisCommandArg GEOHASH_Args[] = {
/* GEOPOS argument table */
struct redisCommandArg GEOPOS_Args[] = {
{"key",ARG_TYPE_KEY,0,NULL,NULL,NULL,CMD_ARG_NONE},
{"member",ARG_TYPE_STRING,-1,NULL,NULL,NULL,CMD_ARG_MULTIPLE},
{"member",ARG_TYPE_STRING,-1,NULL,NULL,NULL,CMD_ARG_OPTIONAL|CMD_ARG_MULTIPLE},
{0}
};
......
......@@ -41,7 +41,8 @@
{
"name": "member",
"type": "string",
"multiple": true
"multiple": true,
"optional": true
}
]
}
......
......@@ -41,7 +41,8 @@
{
"name": "member",
"type": "string",
"multiple": true
"multiple": true,
"optional": true
}
]
}
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment