mirror of
https://github.com/redis/go-redis.git
synced 2025-07-03 02:42:25 +03:00
884f9970c0
* DOC-5078 added basic vector set examples * DOC-5078 formatting and extra comments * DOC-5078 fixed nondeterministic test * wip(tests): run doctests for vector sets on redis 8 only * DOC-5229 added probabilistic data type examples --------- Co-authored-by: Nedyalko Dyakov <nedyalko.dyakov@gmail.com>
Command examples for redis.io
These examples appear on the Redis documentation 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
Exampleand 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 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
doctestsdirectory - Run
go testto test all examples in the directory. - Run
go test filename.goto test a single file