feat!(stdlib): add required description field to Parameter #1610
+515
−0
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
This reverts commit d75af2b.
Contributor
Author
|
Don't want to merge this today as this shouldn't make it into the release happening soon. |
thomasqueirozb
commented
Jan 21, 2026
Comment on lines
+42
to
+49
| - lower_upper | ||
| - upper_lower | ||
| - upper_upper | ||
| - acronym | ||
| - lower_digit | ||
| - upper_digit | ||
| - digit_lower | ||
| - digit_upper |
Contributor
Author
There was a problem hiding this comment.
This list can be improved so that it is generated instead of hard coded but that'd make this PR even bigger
thomasqueirozb
commented
Jan 21, 2026
pront
reviewed
Jan 26, 2026
| @@ -0,0 +1,4 @@ | |||
| The `Parameter` struct now requires a `description` field. Custom VRL functions must provide a | |||
Member
There was a problem hiding this comment.
We can remove this changelog; VRL users are not really affected by this and the change is easy to understand by devs.
8 tasks
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
Adds a required
descriptionfield to theParameterstruct to document what each function parameter does. This is a breaking change as allParameterinstantiations must now include a description.Review Note: This PR is best reviewed commit-by-commit. Some commits contain automated changes and can be skipped during review.
Commits Overview
718dec5 - Adds the new
descriptionfield to theParameterstruct insrc/compiler/function.rsd75af2b - Introduces
update_parameter_descriptions.pywhich automates fetching parameter descriptions from Vector'sdocs.jsonfile. This file (basically) generates the next commit.a1d2ec1 - Automatically generated descriptions. This commit can be skipped. I added all descriptions which matched the cue files but didn't add the TODOs
b74b022 - Create new descriptions for undocumented parameters.
7143948 - Manually add descriptions for parameters that were documented but had a name missmatch (e.g.
ipvsvalue,pathvsvalue)3a5ec83 - Removes the temporary python script
21589cf and later - formatting changes only
Change Type
Is this a breaking change?
How did you test this PR?
cargo checkDoes this PR include user facing changes?
our guidelines.
References
NA