mirror of
https://github.com/redis/go-redis.git
synced 2025-04-16 09:23:06 +03:00
84706fbcef
* Adding examples * Update readme * Update Readme * Remove unneeded lines. Added an examples.json file * Update readme for examples * More fixes * Add example tags * Update examples.json * Rename * Add another hide block * Temporary test * Add example id for lpush and lrange * Update readme * Update output text * Improve examples * Move examples test dir to doctests * Add redis v7's ExpireAtNX, ExpireAtXX, ExpireAtGT, ExpireAtLT, PExpireNX, PExpireXX, PExpireGT, PExpireLT, PExpireAtNX, PExpireAtXX, PExpireAtGT, PExpireAtLT feat: Add redis v7's NX, XX, GT, LT expireat, pexpire, pexpireat variants * add tests for new commands add tests to coverage for the new commands * Adds github workflow to add docexamples tests. Flushes db before every test. * Fixes broken workflow file * Adds Igor’s suggestion of keeping the instructions for docexamples in one place * Removes unneeded “Missing” section, because it was solved as a workflow * Revert "add tests for new commands" This reverts commit af12cb6bd6eba2b68bf90545724f1495fd4797e8. * Fixes review comments * Specifies versions as strings instead of floats --------- Co-authored-by: carner <icarners@gmail.com>
23 lines
894 B
Markdown
23 lines
894 B
Markdown
# Command examples for redis.io
|
|
|
|
These examples appear on the [Redis documentation](https://redis.io) site as part of the tabbed examples interface.
|
|
|
|
## How to add examples
|
|
|
|
- Create a Go test file with a meaningful name in the current folder.
|
|
- Create a single method prefixed with `Example` and write your test in it.
|
|
- Determine the id for the example you're creating and add it as the first line of the file: `// EXAMPLE: set_and_get`.
|
|
- We're using the [Testable Examples](https://go.dev/blog/examples) feature of Go to test the desired output has been written to stdout.
|
|
|
|
### Special markup
|
|
|
|
See https://github.com/redis-stack/redis-stack-website#readme for more details.
|
|
|
|
## How to test the examples
|
|
|
|
- Start a Redis server locally on port 6379
|
|
- CD into the `doctests` directory
|
|
- Run `go test` to test all examples in the directory.
|
|
- Run `go test filename.go` to test a single file
|
|
|