Skip to content

Fix documentation snippets#315

Open
fallintoplace wants to merge 1 commit into
valkey-io:mainfrom
fallintoplace:fix/docs-snippets
Open

Fix documentation snippets#315
fallintoplace wants to merge 1 commit into
valkey-io:mainfrom
fallintoplace:fix/docs-snippets

Conversation

@fallintoplace
Copy link
Copy Markdown

Summary

  • fix invalid valkeyClusterOptions designated-initializer examples in cluster.md
  • fix the gencommands.py link in cluster.md
  • fix the valkeyCommandArgv snippet typo in standalone.md
  • fix the valkeyReply wording typo in standalone.md

Why

Several documentation snippets were not copy-pasteable as written. The cluster docs used semicolons inside C designated initializers, one async example missed the closing ; after the initializer, the gencommands.py link pointed at the wrong directory, and standalone.md had two small typos.

Validation

  • verified scripts/gencommands.py exists
  • confirmed the broken strings and invalid initializer patterns are removed from docs/cluster.md and docs/standalone.md

@fallintoplace fallintoplace marked this pull request as ready for review May 26, 2026 17:23
@bjosv
Copy link
Copy Markdown
Collaborator

bjosv commented May 27, 2026

Good findings, please update the commit with a DCO, see CONTRIBUTING.md

@fallintoplace
Copy link
Copy Markdown
Author

@bjosv I will check later today.

Signed-off-by: Minh Vu <vuhoangminh97@gmail.com>
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 this pull request may close these issues.

2 participants