Skip to content
This repository was archived by the owner on Mar 10, 2020. It is now read-only.

Commit 29f4e84

Browse files
committed
docs: fixes definition of pong
License: MIT Signed-off-by: Alan Shaw <alan@tableflip.io>
1 parent c09d77f commit 29f4e84

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

SPEC/MISCELLANEOUS.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ Where:
131131
}
132132
```
133133

134-
Note that ping response objects aren't all "pongs". A "pong" message can be identified by a truthy `success` property and a `time` property greater than 0. Other ping responses are failures or status updates.
134+
Note that not all ping response objects are "pongs". A "pong" message can be identified by a truthy `success` property and an empty `text` property. Other ping responses are failures or status updates.
135135

136136
If no `callback` is passed, a promise is returned.
137137

@@ -179,7 +179,7 @@ Returns a [`PullStream`][ps] of ping response objects of the form:
179179
}
180180
```
181181

182-
Note that ping response objects aren't all "pongs". A "pong" message can be identified by a truthy `success` property and a `time` property greater than 0. Other ping responses are failures or status updates.
182+
Note that not all ping response objects are "pongs". A "pong" message can be identified by a truthy `success` property and an empty `text` property. Other ping responses are failures or status updates.
183183

184184
**Example:**
185185

@@ -224,7 +224,7 @@ Returns a [`ReadableStream`][rs] of ping response objects of the form:
224224
}
225225
```
226226

227-
Note that ping response objects aren't all "pongs". A "pong" message can be identified by a truthy `success` property and a `time` property greater than 0. Other ping responses are failures or status updates.
227+
Note that not all ping response objects are "pongs". A "pong" message can be identified by a truthy `success` property and an empty `text` property. Other ping responses are failures or status updates.
228228

229229
**Example:**
230230

0 commit comments

Comments
 (0)