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

Document the csv parser's asObjects option #1850

Merged
merged 7 commits into from
Feb 6, 2025
Merged

Conversation

oleiade
Copy link
Member

@oleiade oleiade commented Feb 5, 2025

What?

Documents the newly introduced asObjects option of the k6/experimental/csv module.

Checklist

  • I have used a meaningful title for the PR.
  • I have described the changes I've made in the "What?" section above.
  • I have performed a self-review of my changes.
  • I have run the npm start command locally and verified that the changes look good.
  • I have made my changes in the docs/sources/k6/next folder of the documentation.

Related PR(s)/Issue(s)

grafana/k6#4295

@oleiade oleiade requested review from heitortsergent and a team as code owners February 5, 2025 09:12
@oleiade oleiade requested review from inancgumus and codebien and removed request for a team February 5, 2025 09:12
@oleiade oleiade self-assigned this Feb 5, 2025
@oleiade oleiade added the Area: OSS Content Improvements or additions to community/oss documentation label Feb 5, 2025
Copy link
Contributor

@codebien codebien left a comment

Choose a reason for hiding this comment

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

On this page https://grafana.com/docs/k6/latest/javascript-api/k6-experimental/ the csv link redirects to the wrong page. Can you fix it, please? 🙏

@oleiade
Copy link
Member Author

oleiade commented Feb 5, 2025

Good catch @codebien I've fixed the link 🙇🏻

@oleiade oleiade requested a review from codebien February 5, 2025 09:36
@codebien
Copy link
Contributor

codebien commented Feb 5, 2025

@oleiade Can you fix the broken links on the previous versions as well or at least on the latest online, please?

Copy link
Member

@inancgumus inancgumus left a comment

Choose a reason for hiding this comment

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

LGTM 👍

Co-authored-by: İnanç Gümüş <[email protected]>
@oleiade
Copy link
Member Author

oleiade commented Feb 5, 2025

Fixed the broken links down to version 0.54 where the csv module was introduced.

Copy link
Collaborator

@heitortsergent heitortsergent left a comment

Choose a reason for hiding this comment

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

Left just one tiny suggestion, LGTM! 🙇

@@ -4,7 +4,7 @@ title: javascript-api/k6-experimental

| Modules | Description |
| ------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------- |
| [csv](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-experimental/fs) | Provides support for efficient and convinient of parsing CSV files. |
| [csv](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-experimental/csv) | Provides support for efficient and convenient parsing of CSV files. |
Copy link
Collaborator

Choose a reason for hiding this comment

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

Thanks for fixing this. 🙇

@oleiade oleiade merged commit 54dfba7 into main Feb 6, 2025
5 checks passed
@oleiade oleiade deleted the feature/csv-asobjects branch February 6, 2025 08:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: OSS Content Improvements or additions to community/oss documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants