Add hyperlinks in Valkey server-side scripting and function command files #327
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Added hyperlinks for EVAL_RO and INFO commands. Reworded sentence mentioning the INFO command to work better with the hyperlinks. Signed-off-by: milliehartnt123 <[email protected]>
Added hyperlinks to SCRIPT LOAD and EVAL commands. Signed-off-by: milliehartnt123 <[email protected]>
Added hyperlink for EVAL SHA command. Signed-off-by: milliehartnt123 <[email protected]>
Added hyperlink for the EVAL command. Signed-off-by: milliehartnt123 <[email protected]>
Added hyperlink for FUNCTION LOAD command. Signed-off-by: milliehartnt123 <[email protected]>
Added hyperlink for the FCALL command. Signed-off-by: milliehartnt123 <[email protected]>
Added hyperlink for FUNCTION HELP command. Signed-off-by: milliehartnt123 <[email protected]>
Added hyperlinks for the FUNCTION RESTORE and FUNCTION FLUSH commands. Signed-off-by: milliehartnt123 <[email protected]>
Added hyperlinks for FCALL and FCALL_RO commands. Reworded some text. Signed-off-by: milliehartnt123 <[email protected]>
Added hyperlink for the FUNCTION KILL command. Signed-off-by: milliehartnt123 <[email protected]>
Added hyperlink to SCRIPT HELP command. Signed-off-by: milliehartnt123 <[email protected]>
Added hyperlink for the EVAL command. Added hyperlink to valkey-cli page /topics/cli.md. Removed extra exclamation point ("!") in front of !SYNC bullet.
Signed-off-by: milliehartnt123 <[email protected]>
Added hyperlinks for EVAL SHA, SCRIPT LOAD, and EVAL commands where referenced. Signed-off-by: milliehartnt123 <[email protected]>
Signed-off-by: milliehartnt123 <[email protected]>
Added hyperlinks to EVAL and SHUTDOWN NOSAVE commands Signed-off-by: milliehartnt123 <[email protected]>
Added hyperlinks to EVAL, EVAL SHA, and SCRPT FLUSH commands where referenced. Signed-off-by: milliehartnt123 <[email protected]>
There was a problem hiding this comment.
Pull Request Overview
Adds hyperlinks to inline command references across various Valkey server-side scripting and function command documentation.
- Updated Markdown files to link code references to their corresponding command pages.
- Corrected grammar in
function-load.md. - Standardized sync modifier labels in
script-flush.mdandscript-debug.md.
Reviewed Changes
Copilot reviewed 16 out of 16 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| commands/script.md | Link SCRIPT HELP reference |
| commands/script-load.md | Link EVALSHA, EVAL, and SCRIPT FLUSH commands |
| commands/script-kill.md | Link EVAL and SHUTDOWN NOSAVE commands |
| commands/script-flush.md | Fix SYNC modifier label and link INFO |
| commands/script-exists.md | Link SCRIPT LOAD, EVALSHA, and EVAL |
| commands/script-debug.md | Link EVAL, valkey-cli, update SYNC modifier |
| commands/function.md | Link FUNCTION HELP reference |
| commands/function-stats.md | Link FUNCTION KILL reference |
| commands/function-load.md | Correct grammar and link FCALL/FCALL_RO |
| commands/function-dump.md | Link FUNCTION RESTORE and FUNCTION FLUSH |
| commands/fcall_ro.md | Link FCALL reference |
| commands/fcall.md | Link FUNCTION LOAD reference |
| commands/evalsha_ro.md | Link EVALSHA reference |
| commands/evalsha.md | Link SCRIPT LOAD and EVAL references |
| commands/eval_ro.md | Link EVAL reference |
| commands/eval.md | Link EVAL_RO and INFO references |
Comments suppressed due to low confidence (2)
commands/script.md:3
- [nitpick] This line was converted from a list item to plain text. For consistent formatting, consider restoring the bullet marker (e.g.,
- To see…) so it renders as part of the command list.
To see the list of available commands you can call [SCRIPT HELP](script-help.md).
commands/function-dump.md:8
- [nitpick] The sentence is a bit awkward and merges two actions. Consider rephrasing to "...using
FUNCTION DUMP. Then call FUNCTION FLUSH to delete all libraries." for clarity.
The following example shows how to dump loaded libraries using `FUNCTION DUMP` and then it calls [FUNCTION FLUSH](function-flush.md) deletes all the libraries.
PingXie
reviewed
Jul 6, 2025
commands/eval.md
Outdated
Comment on lines
18
to
19
| Starting from Valkey 8.0, scripts loaded with `EVAL` or [EVAL_RO](eval_ro.md) will be deleted from Valkey after a certain number (least recently used order). | ||
| The number of evicted scripts can be viewed through the `evicted_scripts` parameter in the `stats` section of the [INFO](info.md) command. |
There was a problem hiding this comment.
Suggested change
| Starting from Valkey 8.0, scripts loaded with `EVAL` or [EVAL_RO](eval_ro.md) will be deleted from Valkey after a certain number (least recently used order). | |
| The number of evicted scripts can be viewed through the `evicted_scripts` parameter in the `stats` section of the [INFO](info.md) command. | |
| Starting from Valkey 8.0, scripts loaded with `EVAL` or [`EVAL_RO`](eval_ro.md) will be deleted from Valkey after a certain number (least recently used order). | |
| The number of evicted scripts can be viewed through the `evicted_scripts` field in the `stats` section of the [`INFO`](info.md) command. |
There was a problem hiding this comment.
@PingXie Made change in later commit
commands/evalsha.md
Outdated
Comment on lines
3
to
4
| The server caches scripts by using the [SCRIPT LOAD](script-load.md) command. | ||
| The command is otherwise identical to [EVAL](eval.md). |
There was a problem hiding this comment.
I think we should always add backticks for keywords
Suggested change
| The server caches scripts by using the [SCRIPT LOAD](script-load.md) command. | |
| The command is otherwise identical to [EVAL](eval.md). | |
| The server caches scripts by using the [`SCRIPT LOAD`](script-load.md) command. | |
| The command is otherwise identical to [`EVAL`](eval.md). |
There was a problem hiding this comment.
@PingXie Added tick marks to command hyperlinks in all updated files.
commands/evalsha_ro.md
Outdated
| @@ -1,4 +1,4 @@ | |||
| This is a read-only variant of the `EVALSHA` command that cannot execute commands that modify data. | |||
| This is a read-only variant of the [EVALSHA](evalsha.md) command that cannot execute commands that modify data. | |||
There was a problem hiding this comment.
Suggested change
| This is a read-only variant of the [EVALSHA](evalsha.md) command that cannot execute commands that modify data. | |
| This is a read-only variant of the [`EVALSHA`](evalsha.md) command that cannot execute commands that modify data. |
There was a problem hiding this comment.
@PingXie Added tick marks to command hyperlinks in all updated files.
commands/fcall.md
Outdated
| @@ -1,6 +1,6 @@ | |||
| Invoke a function. | |||
|
|
|||
| Functions are loaded to the server with the `FUNCTION LOAD` command. | |||
| Functions are loaded to the server with the [FUNCTION LOAD](function-load.md) command. | |||
There was a problem hiding this comment.
Suggested change
| Functions are loaded to the server with the [FUNCTION LOAD](function-load.md) command. | |
| Functions are loaded to the server with the [`FUNCTION LOAD`](function-load.md) command. |
There was a problem hiding this comment.
@PingXie Added tick marks to command hyperlinks in all updated files.
commands/fcall_ro.md
Outdated
| @@ -1,4 +1,4 @@ | |||
| This is a read-only variant of the `FCALL` command that cannot execute commands that modify data. | |||
| This is a read-only variant of the [FCALL](fcall.md) command that cannot execute commands that modify data. | |||
There was a problem hiding this comment.
Suggested change
| This is a read-only variant of the [FCALL](fcall.md) command that cannot execute commands that modify data. | |
| This is a read-only variant of the [`FCALL`](fcall.md) command that cannot execute commands that modify data. |
There was a problem hiding this comment.
@PingXie Added tick marks to command hyperlinks in all updated files.
commands/script-kill.md
Outdated
| @@ -1,4 +1,4 @@ | |||
| Kills the currently executing `EVAL` script, assuming no write operation was yet | |||
| Kills the currently executing [EVAL](eval.md) script, assuming no write operation was yet | |||
There was a problem hiding this comment.
Suggested change
| Kills the currently executing [EVAL](eval.md) script, assuming no write operation was yet | |
| Kills the currently executing [`EVAL`](eval.md) script, assuming no write operation was yet |
There was a problem hiding this comment.
@PingXie Added tick marks to command hyperlinks in all updated files.
commands/script-kill.md
Outdated
| @@ -8,7 +8,7 @@ the command returning with an error. | |||
|
|
|||
| If the script has already performed write operations, it can not be killed in this | |||
| way because it would violate Lua's script atomicity contract. | |||
| In such a case, only `SHUTDOWN NOSAVE` can kill the script, killing | |||
| In such a case, only [SHUTDOWN NOSAVE](shutdown.md) can kill the script, killing | |||
There was a problem hiding this comment.
Suggested change
| In such a case, only [SHUTDOWN NOSAVE](shutdown.md) can kill the script, killing | |
| In such a case, only [`SHUTDOWN NOSAVE`](shutdown.md) can kill the script, killing |
There was a problem hiding this comment.
@PingXie Added tick marks to command hyperlinks in all updated files.
commands/script-load.md
Outdated
Comment on lines
3
to
4
| using [EVALSHA](evalsha.md) with the correct SHA1 digest of the script, exactly like after | ||
| the first successful invocation of [EVAL](eval.md). |
There was a problem hiding this comment.
Suggested change
| using [EVALSHA](evalsha.md) with the correct SHA1 digest of the script, exactly like after | |
| the first successful invocation of [EVAL](eval.md). | |
| using [`EVALSHA`](evalsha.md) with the correct SHA1 digest of the script, exactly like after | |
| the first successful invocation of [`EVAL`](eval.md). |
There was a problem hiding this comment.
@PingXie Added tick marks to command hyperlinks in all updated files.
commands/script-load.md
Outdated
Comment on lines
6
to
7
| The script is guaranteed to stay in the script cache forever (unless [SCRIPT | ||
| FLUSH](script-flush.md) is called). |
There was a problem hiding this comment.
Suggested change
| The script is guaranteed to stay in the script cache forever (unless [SCRIPT | |
| FLUSH](script-flush.md) is called). | |
| The script is guaranteed to stay in the script cache forever (unless [`SCRIPT | |
| FLUSH`](script-flush.md) is called). |
There was a problem hiding this comment.
@PingXie Added tick marks to command hyperlinks in all updated files.
commands/script.md
Outdated
| @@ -1,3 +1,3 @@ | |||
| This is a container command for script management commands. | |||
|
|
|||
| To see the list of available commands you can call `SCRIPT HELP`. | |||
| To see the list of available commands you can call [SCRIPT HELP](script-help.md). | |||
There was a problem hiding this comment.
Suggested change
| To see the list of available commands you can call [SCRIPT HELP](script-help.md). | |
| To see the list of available commands you can call [`SCRIPT HELP`](script-help.md). |
There was a problem hiding this comment.
@PingXie Added tick marks to command hyperlinks in all updated files.
Signed-off-by: milliehartnt123 <[email protected]>
Signed-off-by: milliehartnt123 <[email protected]>
…rlink Signed-off-by: milliehartnt123 <[email protected]>
Signed-off-by: milliehartnt123 <[email protected]>
Signed-off-by: milliehartnt123 <[email protected]>
Signed-off-by: milliehartnt123 <[email protected]>
Signed-off-by: milliehartnt123 <[email protected]>
Signed-off-by: milliehartnt123 <[email protected]>
Signed-off-by: milliehartnt123 <[email protected]>
Signed-off-by: milliehartnt123 <[email protected]>
Signed-off-by: milliehartnt123 <[email protected]>
Signed-off-by: milliehartnt123 <[email protected]>
Signed-off-by: milliehartnt123 <[email protected]>
Signed-off-by: milliehartnt123 <[email protected]>
Signed-off-by: milliehartnt123 <[email protected]>
… field Signed-off-by: milliehartnt123 <[email protected]>
zuiderkwast
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hyperlinks were added into the following Valkey server-side scripting and function command files:
#294 part 7