Skip to content

Fix variable names and missing parameters in usage.md code examples #21

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 2 commits into from
Oct 5, 2025
Merged

Fix variable names and missing parameters in usage.md code examples #21

merged 2 commits into from
Oct 5, 2025

Conversation

@i2y
Copy link
Contributor

@i2y i2y commented Oct 4, 2025 •
edited
Loading

This PR fixes code examples in usage.md that contained incorrect variable references and missing parameters:

  • change undefined req to request and msg to message for consistency
  • add missing ctx: RequestContext parameter to streaming methods
  • fix req.msg.sentence → request.sentence (.msg attribute doesn't exist)

@i2y i2y marked this pull request as ready for review October 4, 2025 03:45
@i2y i2y merged commit 0400967 into main Oct 5, 2025
23 checks passed
@i2y i2y deleted the docs/correct-usage-examples branch October 5, 2025 10:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@anuraaga anuraaga anuraaga approved these changes

@stefanvanburen stefanvanburen stefanvanburen approved these changes

@spenczar spenczar Awaiting requested review from spenczar

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@i2y @anuraaga @stefanvanburen