-
Notifications
You must be signed in to change notification settings - Fork 48
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
/topics/lua-api.md
has several problems, RESP naming, and other issues.
#116
Comments
Some of these have been resolved in #85. I need to update that PR. |
The links to |
I'm deleting all references to older versions like "Since 2.6.0", but to help users compare functionality when they upgrade, we've said that we'll keep documentation for the still maintained versions, i.e. 6.2+. I'm removing most of the text about verbatim replication, but keeping small parts, because 6.2 is still supported. Changing "Valkey protocol" to "RESP protocol". (RESP is not an acronym for anything. It's just a name.) Moving the description of the server object to just above where the fields are documented. Some formatting and minor changes. |
Signed-off-by: Viktor Söderqvist <[email protected]>
Closing. This one was fixed in #155 but I forgot to mention it in the top comment. It's mentioned in the commits though. @stockholmux Do you want to remove the "under review" tag for this page on the website? |
In pre-publishing review #91, I discovered a number of issues with
lua-api.md
FYI: A general problems exist in this document with hash links.
Error reply links to a non-existent hash link
/docs/topics/protocol#resp-errors
simple string reply links to a non-existent hash link
/docs/topics/protocol#resp-simple-strings
'Valkey Serialization Protocol' is not a thing, should still be Redis Serialization Protocol.
This should be refactored as 2.6 replication is irrelevant now, and maybe just include 3.2.0 as "before 7". Maybe we don't need to document
server.set_repl(x)
at all? I'm unclear if it's relevant since there is only effect replication now.'Valkey Protocol' should be replaced by RESP
None of these hash links exist on
protocol.md
None of these hash links exist on
protocol.md
[RESP3 true reply](https://github.com/redis/redis-specifications/blob/master/protocol/RESP3.md#boolean-reply) -> Lua true boolean value.
[RESP3 false reply](https://github.com/redis/redis-specifications/blob/master/protocol/RESP3.md#boolean-reply) -> Lua false boolean value.
[RESP3 double reply](https://github.com/redis/redis-specifications/blob/master/protocol/RESP3.md#double-type) -> Lua table with a single _double_ field containing a Lua number representing the double value.
[RESP3 big number reply](https://github.com/redis/redis-specifications/blob/master/protocol/RESP3.md#big-number-type) -> Lua table with a single _big_number_ field containing a Lua string representing the big number value.
[Valkey verbatim string reply](https://github.com/redis/redis-specifications/blob/master/protocol/RESP3.md#verbatim-string-type) -> Lua table with a single _verbatim_string_ field containing a Lua table with two fields, _string_ and _format_, representing the verbatim string and its format, respectively.
None of these hash links exist on
https://github.com/redis/redis-specifications/blob/master/protocol/RESP3.md
Refactor this passage to just put the 2.8.12 way as the way. The rest is irrelevant to Valkey.
The text was updated successfully, but these errors were encountered: