Update stream documentation #599

Merged
merged 2 commits into from Dec 22, 2012

2 participants

@yeban
  • Fix a typo in Stream class's documentation.

  • README: use long polling to exemplify streaming API so it is easy to understand and extend and use in one's code. This also documents Stream#closed? added in sinatra#535.

yeban added some commits Dec 22, 2012
@yeban yeban README: use long polling to exemplify streaming API.
[Long polling][1] is a simple, practical use case of `stream` helper with the
optional `keep_open` parameter.  Let's use it to exemplify streaming API, so it
is easier to understand and use.

[1]: http://en.wikipedia.org/wiki/Push_technology#Long_polling

Signed-off-by: Anurag Priyam <anurag08priyam@gmail.com>
d4ae7f0
@yeban yeban Fix a typo in Stream class's documentation.
Signed-off-by: Anurag Priyam <anurag08priyam@gmail.com>
248e0ea
@rkh
Sinatra member

Cool, thanks.

@rkh rkh closed this Dec 22, 2012
@rkh rkh reopened this Dec 22, 2012
@rkh rkh merged commit 08373e8 into sinatra:master Dec 22, 2012

1 check failed

Details default The Travis build failed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment