Skip to content
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/functions-intro.md has bad formatting, improper framing #104

Closed
stockholmux opened this issue May 27, 2024 · 2 comments · Fixed by #197
Closed

/topics/functions-intro.md has bad formatting, improper framing #104

stockholmux opened this issue May 27, 2024 · 2 comments · Fixed by #197

Comments

@stockholmux
Copy link
Member

stockholmux commented May 27, 2024

In pre-publishing review (#91) I found the following issues on functions-intro.md

!KEYS and ARGV Lua APIs

Using the odd bang formatting which is invalid Valkey syntax.

Redis OSS v7.0 introduces Valkey Functions

Redis didn't introduce Valkey Functions :)

There are plans to support additional engines in the future.

Is this still true? It's probably best to remove forward looking statements in the documentation if there isn't some way to track it with an issue or roadmap item.

@stockholmux stockholmux changed the title /topics/functions-intro.md has outdated information, bad formatting, improper framing /topics/functions-intro.md has bad formatting, improper framing May 27, 2024
@madolson
Copy link
Member

Is this still true? It's probably best to remove forward looking statements in the documentation if there isn't some way to track it with an issue or roadmap item.

No, this was Redis ltd. wording because they wanted to add javascript support to the main engine. We should drop this.

@zuiderkwast
Copy link
Contributor

Gah, this page is written like a promotion text for Functions. I feel like dropping most of it but I don't want to spend time on it. It's hard to resist though.

!KEYS and ARGV Lua APIs

Using the odd bang formatting which is invalid Valkey syntax.

This was used quite consistently throughout the docs (and much of it remains), even in the JSON files about history of command parameters, to prevent an all-caps word from being auto-linked too the command with the same name. Here KEYS doesn't refer to the KEYS command and shouldn't be linked to it.

Do we ever want to auto-link an all-caps words to a command with that name? If not, then we can delete these bangs throughout the docs. I've kept them so far and worked around them in the man page generation, but I don't like these non-markdown marks. I'd be happy to drop them. We should make a separate effort for all pages (grep + review) and another one for the JSON files in the code repo.

There are plans to support additional engines in the future.

Is this still true? It's probably best to remove forward looking statements in the documentation if there isn't some way to track it with an issue or roadmap item.

Hm... We do have some ongoing work to make it possible. I'll change it to "may be possible" and adjust the rest of this text. Some other wordings in this text refers to "engines", that they potentially can exist.

zuiderkwast added a commit to zuiderkwast/valkey-doc that referenced this issue Dec 10, 2024
Signed-off-by: Viktor Söderqvist <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants