docs(website): fix incorrect example about the contains function
#22499
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
The `contains` function is now infallible and always returns a boolean value. This commit fixes the example in the `transformation` guide.
|
|
pront
approved these changes
Feb 24, 2025
domalessi
approved these changes
Feb 24, 2025
pront
added
the
no-changelog
pront
reviewed
Mar 5, 2025
| @@ -138,8 +138,8 @@ transforms: | |||
| # If the log message contains the phrase "Great Scott!", set the new field | |||
| # "critical" to true, otherwise set it to false. If the "contains" function | |||
| # errors, log the error (instead of aborting the script, as above). | |||
| if (is_critical, err = contains(.message, "Great Scott!"); err != null) { | |||
| log(err, level: "error") | |||
| if (is_critical = contains(.message, "Great Scott!"); is_critical) { | |||
There was a problem hiding this comment.
Hm, took another look. This is still a fallible assignment per: playground
What we want instead is:
is_critical = contains(string!(.message), "Great Scott!")
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.
Summary
The
containsfunction is now infallible and always returns a boolean value.This commit fixes the incorrect example in the
transformationguide.Change Type
Is this a breaking change?
How did you test this PR?
Does this PR include user facing changes?
Checklist
make check-allis a good command to run locally. This check isdefined here. Some of these
checks might not be relevant to your PR. For Rust changes, at the very least you should run:
cargo fmt --allcargo clippy --workspace --all-targets -- -D warningscargo nextest run --workspace(alternatively, you can runcargo test --all)Cargo.lock), pleaserun
dd-rust-license-tool writeto regenerate the license inventory and commit the changes (if any). More details here.References