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 streaming api in README #168

Merged
merged 1 commit into from
Nov 18, 2020
Merged

Document streaming api in README #168

merged 1 commit into from
Nov 18, 2020

Conversation

trevorsibanda
Copy link
Contributor

Docs follow up to #165

Copy link

@lregnier lregnier left a comment

Choose a reason for hiding this comment

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

LGTM

Maybe @faunaee wants to sign off the wording here (in case he as time to do it), but it LGTM.


The following section provides an example for managing a document stream.

The streaming API is blocking by default, the choice and mechanism for handling concurrent streams is left to the application developer:

Choose a reason for hiding this comment

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

If my grammar is sound, I think it should be "are" here:

Suggested change
The streaming API is blocking by default, the choice and mechanism for handling concurrent streams is left to the application developer:
The streaming API is blocking by default, the choice and mechanism for handling concurrent streams are left to the application developer:

@trevorsibanda trevorsibanda merged commit 7559b55 into master Nov 18, 2020
@cleve-fauna cleve-fauna deleted the streaming-doc branch February 11, 2022 01:15
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.

3 participants