History

andy-stark-redis 9e3709c404 DOC-4234 added bitmap examples (#3124 ) Co-authored-by: Vladyslav Vildanov <117659936+vladvildanov@users.noreply.github.com>		2024-09-25 21:03:54 +03:00
..
README.md	Adds testable examples to be automatically pulled in redis.io docs (#2601 )	2023-05-31 14:22:55 +01:00
bitmap_tutorial_test.go	DOC-4234 added bitmap examples (#3124 )	2024-09-25 21:03:54 +03:00
hash_tutorial_test.go	Doc 4226 hash tces (#3106 )	2024-09-12 11:45:38 +03:00
list_tutorial_test.go	DOC-4230 list doc code examples (#3110 )	2024-09-12 13:54:42 +03:00
lpush_lrange_test.go	Format code and fix go vet (#2696 )	2023-09-20 14:03:44 +03:00
set_get_test.go	Format code and fix go vet (#2696 )	2023-09-20 14:03:44 +03:00
sets_example_test.go	DOC-4231 added set datatype examples (#3111 )	2024-09-12 14:16:15 +03:00
ss_tutorial_test.go	DOC-4229 sorted set code examples (#3113 )	2024-09-12 16:26:16 +03:00
string_example_test.go	DOC-4213 string code examples (#3102 )	2024-09-06 14:49:25 +03:00
tdigest_tutorial_test.go	DOC-4241 added t-digest examples (#3123 )	2024-09-25 19:54:20 +03:00

README.md

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 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 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