Improve clarity around BatchKeyFn function usage #22
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Owner
|
Hi, thank you so much for this PR and your feedback. I'm currently working on a documentation branch to polish it further, and your input is really valuable. I have a lot going on at work right now, but as soon as I have some time, I'll look into incorporating these changes too |
Owner
|
Hi again, I've cherry-picked some of the documentation changes that I have been working on while also trying to incorporate your feedback in this PR: #25. Please let me know if you have any feedback! |
Owner
|
I'll close this for now given the updated documentation and comments. Please feel free to open an issue if you still feel like it's unclear or could be explained better |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hi,
first of all amazing library.
The documentation, examples and structure make it really easy and fun to implement.
I am opening this pull request to suggest a small change in the documentation around the BatchKeyFn.
From the current documentation I always thought that the function only combines the two strings (prefix and id).
But after troubleshooting and checking the code I realized it uses a "-ID-" format which was not described anywhere. This lead to an issue for me as I prefixed the keys myself when using the SetMany function.
In addition to the documentation changes, I would also suggest replacing the "magic formatting/string" with a exported variable as this makes it easier to prefix the keys when the BatchKeyFn is not applicable.