Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC add pipeline examples #2240

Merged
merged 3 commits into from
Jun 23, 2022

Conversation

Iglesys347
Copy link
Contributor

Pull Request check-list

Please make sure to review and check all of these items:

  • Does $ tox pass with this change (including linting)?
  • Do the CI tests pass with this change (enable it first in your forked repo and wait for the github action build to finish)?
  • Is the new or changed code fully tested?
  • Is a documentation update included (if this change modifies existing APIs, or introduces new ones)?
  • Is there an example added to the examples folder (if applicable)?
  • Was the change added to CHANGES file?

NOTE: these things are not required to open a PR and can be done
afterwards / while the PR is open.

Description of change

This PR relates to #1744

I created a simple jupyter example of how to use pipelines with a performance comparison.

@Iglesys347 Iglesys347 mentioned this pull request Jun 20, 2022
@chayim
Copy link
Contributor

chayim commented Jun 21, 2022

Hi @Iglesys347 this is awesome! Any chance you can add this, as a link in the examples.rst?

@chayim chayim added the maintenance Maintenance (CI, Releases, etc) label Jun 21, 2022
@codecov-commenter
Copy link

codecov-commenter commented Jun 21, 2022

Codecov Report

Merging #2240 (2412c5c) into master (bea7299) will increase coverage by 0.00%.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master    #2240   +/-   ##
=======================================
  Coverage   91.85%   91.85%           
=======================================
  Files         108      108           
  Lines       27743    27743           
=======================================
+ Hits        25482    25484    +2     
+ Misses       2261     2259    -2     
Impacted Files Coverage Δ
tests/test_cluster.py 97.03% <0.00%> (+0.11%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update bea7299...2412c5c. Read the comment docs.

@Iglesys347
Copy link
Contributor Author

Hi @chayim, I added the notebook to example.rst and I tested locally (with invoke build-docs) everything seems to work properly.

The CI fails due to an internal server error, I'll try to re-trigger it latter.

@Iglesys347
Copy link
Contributor Author

All check passes 😄

Copy link
Collaborator

@dvora-h dvora-h left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Iglesys347 Thank you for helping make our documentation better!

@dvora-h dvora-h merged commit 23fd327 into redis:master Jun 23, 2022
@Iglesys347 Iglesys347 deleted the DOC-add-pipeline-jupyter-example branch July 8, 2022 09:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
maintenance Maintenance (CI, Releases, etc)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants