Improve documentation of the events array.

(imported from commit d53f561cbf1e802ed34fe8030aa7759ef9b15631)
This commit is contained in:
Tim Abbott
2013-12-11 17:44:55 -05:00
parent 2e62cd5a74
commit 218321deb6

View File

@@ -120,7 +120,7 @@
"returns": [
[
"events",
"an array (possibly zero-length if dont_block is set) of events with IDs newer than `last_event_id`"
"an array (possibly zero-length if dont_block is set) of events with IDs newer than `last_event_id`. Event IDs are guaranted to be increasing, but they are not guaranteed to be consecutive."
]
],
"call": "Get new events from an events queue",