Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(vrl): Add documentation for new object_from_array function #21969

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

bruceg
Copy link
Member

@bruceg bruceg commented Dec 5, 2024

Summary

Ref: vectordotdev/vrl#1164 vectordotdev/vrl#1176 vectordotdev/vrl#1177

Change Type

  • Bug fix
  • New feature
  • Non-functional (chore, refactoring, docs)
  • Performance
  • Enhancement

Is this a breaking change?

  • Yes
  • No

How did you test this PR?

N/A

Does this PR include user facing changes?

  • Yes. Please add a changelog fragment based on our guidelines.
  • No. A maintainer will apply the "no-changelog" label to this PR.

Checklist

  • Please read our Vector contributor resources.
  • If this PR introduces changes Vector dependencies (modifies Cargo.lock), please
    run dd-rust-license-tool write to regenerate the license inventory and commit the changes (if any). More details here.

References

@bruceg bruceg added domain: external docs Anything related to Vector's external, public documentation transform: remap Anything `remap` transform related vrl: stdlib changes to VRL's standard library. no-changelog Changes in this PR do not need user-facing explanations in the release changelog labels Dec 5, 2024
@bruceg bruceg requested review from a team as code owners December 5, 2024 18:23
@bruceg bruceg added the type: tech debt A code change that does not add user value. label Dec 5, 2024
@datadog-vectordotdev
Copy link

datadog-vectordotdev bot commented Dec 5, 2024

Datadog Report

Branch report: bruceg/vrl-object-docs
Commit report: 0d9682f
Test service: vector

✅ 0 Failed, 7 Passed, 0 Skipped, 25.53s Total Time

@bruceg bruceg force-pushed the bruceg/vrl-object-docs branch from 68feeae to b35469a Compare December 5, 2024 18:41
@bruceg
Copy link
Member Author

bruceg commented Dec 9, 2024

Thanks for the feedback @neko-dd. Addressed in 10380c0

This needs a version bump to the vrl crate, but it doesn't look like that is happening automatically any more. Is there some blockage there that will need a manual PR?

@bruceg bruceg requested a review from neko-dd December 9, 2024 19:40
website/cue/reference/remap/functions/zip.cue Outdated Show resolved Hide resolved
remap: functions: object_from_array: {
category: "Object"
description: """
Iterate over either one or a pair of arrays and create an object out of all the key-value pairs contained in them.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Iterate over either one or a pair of arrays and create an object out of all the key-value pairs contained in them.
Iterate over either one array of arrays or a pair of arrays and create an object out of all the key-value pairs contained in them.

Is this more correct, by chance?

Comment on lines 7 to 8
Any entries that are missing the value use `null` instead.
Any keys that are `null` skip the corresponding value.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Any entries that are missing the value use `null` instead.
Any keys that are `null` skip the corresponding value.
Any entries with no value use `null` instead.
Any keys that are `null` skip the corresponding value.

@pront
Copy link
Member

pront commented Dec 10, 2024

This needs a version bump to the vrl crate, but it doesn't look like that is happening automatically any more. Is there some blockage there that will need a manual PR?

It does happen. But it is on a weekly schedule.

@pront pront added this to the Vector v0.44.0 milestone Dec 10, 2024
@pront
Copy link
Member

pront commented Dec 10, 2024

I mark PRs like with a milestone so that we remember to include them in the next minor release.

@bruceg bruceg requested a review from neko-dd December 16, 2024 01:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
domain: external docs Anything related to Vector's external, public documentation no-changelog Changes in this PR do not need user-facing explanations in the release changelog transform: remap Anything `remap` transform related type: tech debt A code change that does not add user value. vrl: stdlib changes to VRL's standard library.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants