valkey icon indicating copy to clipboard operation
valkey copied to clipboard

Fix all the little inconsistencies in the json command file descriptions

Open madolson opened this issue 10 months ago • 3 comments

Ideally all of the description should be:

  1. Full sentences with capitalization
  2. Include punctuation.

madolson avatar Mar 26 '24 18:03 madolson

This is how to find them:

$ cd src/commands
src/commands$ git grep '"description": "[a-z]'
acl-getuser.json:                    "description": "a set of ACL rule definitions for the user",
acl-getuser.json:                            "description": "root selector's commands",
acl-getuser.json:                            "description": "root selector's keys",
acl-getuser.json:                            "description": "root selector's channels",
bitop.json:            "description": "the size of the string stored in the destination key, that is equal to the size of the longest input string",
bitpos.json:                    "description": "the position of the first bit set to 1 or 0 according to the request",
client-info.json:            "description": "a unique string, as described at the CLIENT LIST page, for the current client",
...

zuiderkwast avatar Mar 27 '24 19:03 zuiderkwast

hi @CharlesChen888 @zuiderkwast can u please assign this issue to me i can try my hand on it and little more description on the expectations is highly appreciated.

tushar-coin avatar Mar 30 '24 19:03 tushar-coin

I think #63 does it. We should have that merged, once the python scripts are fixed. See comments in that PR.

zuiderkwast avatar Mar 30 '24 22:03 zuiderkwast