History

Tiago Peczenyj e8ad794e96 Format code and fix go vet (#2696 ) * run go fix ./... Signed-off-by: Tiago Peczenyj <tpeczenyj@weborama.com> * run make fmt Signed-off-by: Tiago Peczenyj <tpeczenyj@weborama.com> * fix go vet ./... issues * Update README.md Reorder imports with the rules defined in the Makefile as if we run `make fmt` * run gofumpt -w . * update Makefile to use gofumpt instead gofmt * increment makefile * format test * format tests Signed-off-by: Tiago Peczenyj <tpeczenyj@weborama.com> --------- Signed-off-by: Tiago Peczenyj <tpeczenyj@weborama.com> Co-authored-by: ofekshenawa <104765379+ofekshenawa@users.noreply.github.com>		2023-09-20 14:03:44 +03:00
..
README.md	Adds testable examples to be automatically pulled in redis.io docs (#2601 )	2023-05-31 14:22:55 +01: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

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