presence: Fix get_by_key documentation and typespec inconsistencies#6719
Open
wondr-wclabs wants to merge 1 commit into
Open
presence: Fix get_by_key documentation and typespec inconsistencies#6719wondr-wclabs wants to merge 1 commit into
wondr-wclabs wants to merge 1 commit into
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Fixes #5759 and #4514. The
get_by_key/2function was incorrectly documented as returning a list of maps, and the typespec reflected this, but the implementation actually returns a map (or an empty list if not found). This PR updates the typespec and example in the documentation to accurately match the implementation without introducing breaking changes.