Skip to content

Commit 2c3c6dd

Browse files
authored
[DOCS-2823] README: Remove class names in method refs (#185)
1 parent e714cf6 commit 2c3c6dd

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

README.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -166,7 +166,7 @@ client = Client(http_idle_timeout=timedelta(seconds=6))
166166
```
167167

168168
> **Note**
169-
> Your application process may continue executing after all requests are completed for the duration of the session idle timeout. To prevent this, it is recommended to call ``Client.close()`` once all requests are complete. It is not recommended to set ``http_idle_timeout`` to small values.
169+
> Your application process may continue executing after all requests are completed for the duration of the session idle timeout. To prevent this, it is recommended to call ``close()`` once all requests are complete. It is not recommended to set ``http_idle_timeout`` to small values.
170170
171171
### Connect Timeout
172172

@@ -247,12 +247,12 @@ except ServiceError as e:
247247

248248
## Pagination
249249

250-
Use the ``Client.paginate()`` method to iterate sets that contain more than one
250+
Use the ``paginate()`` method to iterate sets that contain more than one
251251
page of results.
252252

253-
``Client.paginate()`` accepts the same query options as ``Client.query()``.
253+
``paginate()`` accepts the same query options as ``query()``.
254254

255-
Change the default items per page using FQL's ``<set>.pageSize()`` method.
255+
Change the default items per page using FQL's ``pageSize()`` method.
256256

257257
```python
258258
from datetime import timedelta
@@ -289,7 +289,7 @@ To get a stream token, append ``toStream()`` or ``changesOn()`` to a set from a
289289

290290

291291
To start and subscribe to the stream, pass the stream token to
292-
``Client.stream()``:
292+
``stream()``:
293293

294294
```python
295295
from fauna import fql
@@ -312,7 +312,7 @@ To start and subscribe to the stream, pass the stream token to
312312
```
313313

314314
You can also pass a query that produces a stream token directly to
315-
``Client.stream()``:
315+
``stream()``:
316316

317317
```python
318318
query = fql('Product.all().changesOn(.price, .quantity)')
@@ -322,7 +322,7 @@ You can also pass a query that produces a stream token directly to
322322

323323
### Iterate on a stream
324324

325-
``Client.stream()`` returns an iterator that emits events as they occur. You can
325+
``stream()`` returns an iterator that emits events as they occur. You can
326326
use a generator expression to iterate through the events:
327327

328328
```python
@@ -344,7 +344,7 @@ with client.stream(query) as stream:
344344

345345
### Close a stream
346346

347-
Use ``<stream>.close()`` to close a stream:
347+
Use ``close()`` to close a stream:
348348

349349
```python
350350
query = fql('Product.all().changesOn(.price, .quantity)')
@@ -384,7 +384,7 @@ except FaunaException as e:
384384
```
385385
### Stream options
386386

387-
The client configuration sets default options for the ``Client.stream()``
387+
The client configuration sets default options for the ``stream()``
388388
method.
389389

390390
You can pass a ``StreamOptions`` object to override these defaults:

0 commit comments

Comments
 (0)