Simple documentation examples as test cases

[dmaier-redislabs]

Hello,

this pull request adds an additional test project to the existing NRedisStack solution.

The idea is that the files in this project will be pulled for code examples within the documentation on redis.io. It would be good to run this test project on a regular basis for new versions of NRedisStack in order to ensure that the documentation examples are functional.

In the sake of the example, we tried to minimize the surrounding code as much as possible. This includes, for instance:

• A simple but not too abstract way of establishing the connection
• A neutral method name (e.g., run)
• Minimal error handling
• Blocks of code that are 'by default hidden' (HIDE_START ... HIDE_END) or entirely hidden (REMOVE_START ... REMOVE_END) within the documentation.
• The [Fact] test annotation will not be visible in the documentation.

Regards,
David

[shacharPash]

@dmaier-redislabs thanks for contributing to the project!
Just asking, What is the advantage of what you suggested compared to the current situation, where there is a separate test file for the code that appears in the examples?
You can look at my last PRs, I've been working on this test file.

[uglide]

@shacharPash It's special examples for redis.io. See https://github.com/redis-stack/redis-stack-website/blob/017cfd02a29895fdc5464800965abfbcc3a0f93b/README.md and merged code to redis-py https://github.com/redis/redis-py/tree/emb-examples/doctests for more details

[codecov-commenter]

Codecov Report

Patch and project coverage have no change.

Comparison is base (ccae59f) 93.27% compared to head (aadf9b5) 93.27%.

📣 This organization is not using Codecov’s GitHub App Integration. We recommend you install it so Codecov can continue to function properly for your repositories. Learn more

Additional details and impacted files

@@           Coverage Diff           @@
##           master     #114   +/-   ##
=======================================
  Coverage   93.27%   93.27%           
=======================================
  Files          77       77           
  Lines        4582     4582           
  Branches      424      424           
=======================================
  Hits         4274     4274           
  Misses        186      186           
  Partials      122      122           

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.