docs: Clarify error behavior of subscript operator and suggest element_at alternative #21329
Conversation
This file contains 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
ebyhr
reviewed
Mar 31, 2024
There was a problem hiding this comment.
The commit message is too long. It should be ~50 characters as a soft limit. Also, we don't use docs: prefix.
https://github.com/trinodb/trino/blob/master/.github/DEVELOPMENT.md#commits-and-pull-requests is a commit message guideline in this repository.
Please change to "Document behavior when key doesn't exist in map subscript operator" or something.
yassan
force-pushed
the
add-warning-for-subscript-operator
branch
from
b638054 to
b7bb1b6
Compare
ebyhr
reviewed
Mar 31, 2024
There was a problem hiding this comment.
Please squash commits into one. We use rebase and merge in this repository.
https://github.com/trinodb/trino/blob/master/.github/DEVELOPMENT.md#git-merge-strategy
ebyhr
force-pushed
the
add-warning-for-subscript-operator
branch
from
b7bb1b6 to
5d91660
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
This commit updates the documentation to clearly state that using the subscript operator
[]will result in an error if the specified key does not exist.It also recommends using the
element_atfunction as a safer alternative when there is a possibility that the key might not be present. This change aims to improve clarity and aid developers in handling potential errors more effectively.cf. https://trinodb.slack.com/archives/CLEDR9V7G/p1702021254436669?thread_ts=1702003731.904799&cid=CLEDR9V7G
Release notes
(x) This is not user-visible or is docs only, and no release notes are required.