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

async_cluster: improve docs #2208

Merged
merged 1 commit into from
Jun 2, 2022

Conversation

utkarshgupta137
Copy link
Contributor

Pull Request check-list

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

Description of change

  • move response_callbacks kwarg inside init to hide it from docs
  • use :member-order: bysource to group similar commands together

- move response_callbacks kwarg inside __init__ to hide it from docs
- use :member-order: bysource to group similar commands together
@utkarshgupta137
Copy link
Contributor Author

@dvora-h The documentation for async cluster is missing for existing versions: https://redis-py.readthedocs.io/en/v4.3.0/connections.html#async-cluster-client

@codecov-commenter
Copy link

codecov-commenter commented Jun 1, 2022

Codecov Report

Merging #2208 (19e5d32) into master (a2365d1) will decrease coverage by 0.00%.
The diff coverage is 93.33%.

@@            Coverage Diff             @@
##           master    #2208      +/-   ##
==========================================
- Coverage   91.84%   91.84%   -0.01%     
==========================================
  Files         108      108              
  Lines       27691    27690       -1     
==========================================
- Hits        25433    25432       -1     
  Misses       2258     2258              
Impacted Files Coverage Δ
redis/asyncio/cluster.py 89.91% <93.33%> (-0.02%) ⬇️

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 a2365d1...19e5d32. Read the comment docs.

@dvora-h dvora-h added the maintenance Maintenance (CI, Releases, etc) label Jun 2, 2022
@dvora-h dvora-h merged commit 535a612 into redis:master Jun 2, 2022
@utkarshgupta137 utkarshgupta137 deleted the async_cluster_docs branch June 2, 2022 14:19
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.

3 participants