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

gRPC Stream class docs #1535

Merged
merged 2 commits into from Mar 28, 2024
Merged

gRPC Stream class docs #1535

merged 2 commits into from Mar 28, 2024

Conversation

olegbespalov
Copy link
Contributor

@olegbespalov olegbespalov commented Mar 26, 2024

What?

This change fixes the missed gRPC Stream class signature and improves its documentation.

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/next folder of the documentation.
  • I have reflected my changes in the docs/sources/v{most_recent_release} folder of the documentation.
  • I have reflected my changes in the relevant folders of the two previous k6 versions of the documentation (if still applicable to previous versions).

Related PR(s)/Issue(s)

Spotted during https://community.grafana.com/t/k6-server-grpc-streaming-with-accesstoken-metadata/117879

@olegbespalov olegbespalov requested review from a team and mstoykov and removed request for a team March 26, 2024 11:20
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 some small edits, other than that everything looks good! Might need to run prettier again on the files to fix the tables if you accept them. 🙇

@olegbespalov
Copy link
Contributor Author

@heitortsergent thanks! 👍 I hope I've applied all the suggestions in a separate commit. Could you please have a final look and re-approve it? ☺️

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.

LGTM! 🚀 :shipit:

@olegbespalov olegbespalov merged commit 335aad7 into main Mar 28, 2024
5 checks passed
@olegbespalov olegbespalov deleted the chore/fix-grpc-params branch March 28, 2024 10:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants