Skip to content

Conversation

@mkmkme
Copy link
Collaborator

@mkmkme mkmkme commented Jul 9, 2025

Pull Request check-list

  • Do tests and lints pass with this change?
  • 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)?

Description of change

Some minor documentation changes needed before releasing 6.1.1. Fixes #133, fixes #191

Mikhail Koviazin added 3 commits July 9, 2025 14:12
Signed-off-by: Mikhail Koviazin <[email protected]>
Fixes #133

Signed-off-by: Mikhail Koviazin <[email protected]>
In ValkeyCluster, the cursors are returned as a dict of primaries with
names as keys and cursors as values. Mention that in help to avoid
confusion.

Fixes #191

Signed-off-by: Mikhail Koviazin <[email protected]>
@mkmkme mkmkme added this to the 6.1.1 milestone Jul 9, 2025
@mkmkme
Copy link
Collaborator Author

mkmkme commented Jul 9, 2025

@amirreza8002 could you have a look at this as the author of #191 ?

@mkmkme mkmkme enabled auto-merge July 9, 2025 12:58
@codecov-commenter
Copy link

codecov-commenter commented Jul 9, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 76.27%. Comparing base (46bb06e) to head (31d996f).

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #212      +/-   ##
==========================================
- Coverage   76.27%   76.27%   -0.01%     
==========================================
  Files         130      130              
  Lines       33985    33985              
==========================================
- Hits        25923    25921       -2     
- Misses       8062     8064       +2     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@amirreza8002
Copy link
Contributor

hi
i was thinking, maybe the return type should be adjusted as well

i think it'd be something like:
Union[tuple[int, list[KeyT]], Awaitable[tuple[int, list[KeyT]]], tuple[dict[str, int], list[KeyT]], Awaitable[tuple[dict[str, int], list[KeyT]]

@mkmkme
Copy link
Collaborator Author

mkmkme commented Jul 10, 2025

@amirreza8002 let's not fix the types in the scope of this PR. Typing is a much larger problem that doesn't have to be fixed by 6.1.1. Documentation OTOH is more important. Current return type is not incorrect, it's just too wide.

@mkmkme mkmkme merged commit 1af9f64 into main Jul 10, 2025
85 checks passed
@mkmkme mkmkme deleted the mkmkme/doc-fixes branch July 10, 2025 12:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

cluster scan returns a dict as cursor Add reference to Valkey's matrix channel in doc

5 participants