Skip to content

Commit e5dc8c9

Browse files
authored
docs: Update several feature names to sentence case (#213)
1 parent 6de402a commit e5dc8c9

File tree

2 files changed

+18
-18
lines changed

2 files changed

+18
-18
lines changed

README.md

+12-12
Original file line numberDiff line numberDiff line change
@@ -285,13 +285,13 @@ for products in pages:
285285
print(products)
286286
```
287287

288-
## Event Feeds
288+
## Event feeds
289289

290-
The driver supports [Event Feeds](https://docs.fauna.com/fauna/current/learn/cdc/#event-feeds).
290+
The driver supports [event feeds](https://docs.fauna.com/fauna/current/learn/cdc/#event-feeds).
291291

292-
### Request an Event Feed
292+
### Request an event feed
293293

294-
An Event Feed asynchronously polls an [event source](https://docs.fauna.com/fauna/current/learn/cdc/#create-an-event-source)
294+
An event feed asynchronously polls an [event source](https://docs.fauna.com/fauna/current/learn/cdc/#create-an-event-source)
295295
for paginated events.
296296

297297
To get an event source, append ``eventSource()`` or ``eventsOn()`` to a
@@ -327,7 +327,7 @@ You can also pass a query that produces an event source directly to ``feed()``:
327327
client.feed(query)
328328
```
329329

330-
### Iterate on an Event Feed
330+
### Iterate on an event feed
331331

332332
``feed()`` returns an iterator that emits pages of events. You can use a
333333
generator expression to iterate through the pages:
@@ -364,11 +364,11 @@ Alternatively, you can iterate through events instead of pages with
364364
## ...
365365
```
366366

367-
The Event Feed iterator stops when there are no more events to poll.
367+
The event feed iterator stops when there are no more events to poll.
368368

369369
### Error handling
370370

371-
If a non-retryable error occurs when opening or processing an Event Feed, Fauna
371+
If a non-retryable error occurs when opening or processing an event feed, Fauna
372372
raises a ``FaunaException``:
373373

374374
```python
@@ -422,7 +422,7 @@ processing. For example:
422422
print('error ocurred with event processing: ', e)
423423
```
424424

425-
### Event Feed options
425+
### Event feed options
426426

427427
The client configuration sets default options for the ``feed()`` method.
428428

@@ -441,14 +441,14 @@ options = FeedOptions(
441441
client.feed(fql('Product.all().eventSource()'), options)
442442
```
443443

444-
## Event Streaming
444+
## Event streams
445445

446-
The driver supports [Event
447-
Streaming](https://docs.fauna.com/fauna/current/reference/cdc/#event-streaming).
446+
The driver supports [event
447+
streams](https://docs.fauna.com/fauna/current/reference/cdc/#event-streaming).
448448

449449
### Start a stream
450450

451-
An Event Stream lets you consume events from an [event
451+
An event stream lets you consume events from an [event
452452
source](https://docs.fauna.com/fauna/current/learn/cdc/#create-an-event-source)
453453
as a real-time subscription.
454454

fauna/client/client.py

+6-6
Original file line numberDiff line numberDiff line change
@@ -75,12 +75,12 @@ class StreamOptions:
7575
@dataclass
7676
class FeedOptions:
7777
"""
78-
A dataclass representing options available for an Event Feed.
78+
A dataclass representing options available for an event feed.
7979
80-
* max_attempts - The maximum number of times to attempt an Event Feed query when a retryable exception is thrown.
80+
* max_attempts - The maximum number of times to attempt an event feed query when a retryable exception is thrown.
8181
* max_backoff - The maximum backoff in seconds for an individual retry.
8282
* query_timeout - Controls the maximum amount of time Fauna will execute a query before returning a page of events.
83-
* start_ts - The starting timestamp of the Event Feed, exclusive. If set, Fauna will return events starting after
83+
* start_ts - The starting timestamp of the event feed, exclusive. If set, Fauna will return events starting after
8484
the timestamp.
8585
* cursor - The starting event cursor, exclusive. If set, Fauna will return events starting after the cursor.
8686
* page_size - Maximum number of events returned per page. Must be in the
@@ -468,10 +468,10 @@ def feed(
468468
opts: FeedOptions = FeedOptions(),
469469
) -> "FeedIterator":
470470
"""
471-
Opens an Event Feed in Fauna and returns an iterator that consume Fauna events.
471+
Opens an event feed in Fauna and returns an iterator that consume Fauna events.
472472
473473
:param source: An EventSource or a Query that returns an EventSource.
474-
:param opts: (Optional) Event Feed options.
474+
:param opts: (Optional) Event feed options.
475475
476476
:return: a :class:`FeedIterator`
477477
@@ -661,7 +661,7 @@ def __iter__(self) -> Iterator[Any]:
661661

662662

663663
class FeedIterator:
664-
"""A class to provide an iterator on top of Event Feed pages."""
664+
"""A class to provide an iterator on top of event feed pages."""
665665

666666
def __init__(self, http: HTTPClient, headers: Dict[str, str], endpoint: str,
667667
max_attempts: int, max_backoff: int, opts: FeedOptions,

0 commit comments

Comments
 (0)