Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Update several feature names to sentence case #231

Merged
merged 2 commits into from
Jan 28, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions Fauna/Core/FeedEnumerable.cs
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ namespace Fauna.Core;


/// <summary>
/// Represents a Fauna Event Feed.
/// Represents a Fauna event feed.
/// </summary>
/// <typeparam name="T">Type to map each of the Events to.</typeparam>
public class FeedEnumerable<T> where T : notnull
Expand All @@ -19,7 +19,7 @@ public class FeedEnumerable<T> where T : notnull
public string? Cursor => CurrentPage?.Cursor;

/// <summary>
/// The latest page returned from the Event Feed enumerator.
/// The latest page returned from the event feed enumerator.
/// </summary>
public FeedPage<T>? CurrentPage { get; private set; }

Expand Down
2 changes: 1 addition & 1 deletion Fauna/Core/FeedOptions.cs
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
namespace Fauna.Core;

/// <summary>
/// Represents the options when subscribing to Fauna Event Feeds.
/// Represents the options when subscribing to Fauna event feeds.
/// </summary>
public class FeedOptions : EventOptions
{
Expand Down
2 changes: 1 addition & 1 deletion Fauna/Core/FeedPage.cs
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
namespace Fauna.Core;

/// <summary>
/// Represents the response from Fauna Event Feed requests.
/// Represents the response from Fauna event feed requests.
/// </summary>
/// <typeparam name="T"></typeparam>
public class FeedPage<T> where T : notnull
Expand Down
2 changes: 1 addition & 1 deletion Fauna/Core/StreamEnumerable.cs
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
namespace Fauna.Core;

/// <summary>
/// A class representing a Fauna Event Stream. Additional queries will be made during enumeration.
/// A class representing a Fauna event stream. Additional queries will be made during enumeration.
/// </summary>
/// <typeparam name="T">The return type of the stream.</typeparam>
public class StreamEnumerable<T> where T : notnull
Expand Down
4 changes: 2 additions & 2 deletions Fauna/Core/StreamOptions.cs
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
namespace Fauna;

/// <summary>
/// Represents the options when subscribing to Fauna Event Streams.
/// Represents the options when subscribing to Fauna event streams.
/// </summary>
public class StreamOptions : EventOptions
{
Expand All @@ -12,7 +12,7 @@ public class StreamOptions : EventOptions
/// </summary>
/// <param name="token">The token for a Fauna event source.</param>
/// <param name="cursor">The cursor from the stream, must be used with the associated Token. Used to resume the stream.</param>
/// See <a href="https://docs.fauna.com/fauna/current/reference/cdc/#restart">Restart an Event Stream</a>.
/// See <a href="https://docs.fauna.com/fauna/current/reference/cdc/#restart">Restart an event stream</a>.
public StreamOptions(string token, string cursor)
{
Token = token;
Expand Down
2 changes: 1 addition & 1 deletion Fauna/Exceptions/EventException.cs
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
namespace Fauna.Exceptions;

/// <summary>
/// Represents an exception related to Fauna Event Stream and Event Feed errors.
/// Represents an exception related to Fauna event stream and event feed errors.
/// </summary>
public class EventException : ServiceException
{
Expand Down
6 changes: 3 additions & 3 deletions Fauna/Types/Event.cs
Original file line number Diff line number Diff line change
Expand Up @@ -26,13 +26,13 @@ public enum EventType
/// </summary>
Remove,
/// <summary>
/// A status event. Typically used as an implementation detail for a driver. Indicates a status change on the stream. Not emitted for Event Feeds.
/// A status event. Typically used as an implementation detail for a driver. Indicates a status change on the stream. Not emitted for event feeds.
/// </summary>
Status
}

/// <summary>
/// A class representing an event from an Event Feed or Event Stream.
/// A class representing an event from an event feed or event stream.
/// </summary>
/// <typeparam name="T"></typeparam>
public class Event<T> where T : notnull
Expand All @@ -46,7 +46,7 @@ public class Event<T> where T : notnull
/// </summary>
public long TxnTime { get; private init; }
/// <summary>
/// A cursor for the event. Used to resume an Event Feed or Event Stream after the event.
/// A cursor for the event. Used to resume an event feed or event stream after the event.
/// </summary>
public string Cursor { get; private init; } = null!;
/// <summary>
Expand Down
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -288,12 +288,12 @@ if (r.Data.Exists) {

```

## Event Feeds
## Event feeds (beta)

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

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

Expand Down Expand Up @@ -328,11 +328,11 @@ await foreach (var page in feed)
}
```

## Event Streaming
## Event streams

The driver supports [Event Streaming](https://docs.fauna.com/fauna/current/learn/cdc/#event-streaming).
The driver supports [event streams](https://docs.fauna.com/fauna/current/learn/cdc/#event-streaming).

To start and subscribe to an Event Stream, pass a query that produces an [event
To start and subscribe to an event stream, pass a query that produces an [event
source](https://docs.fauna.com/fauna/current/learn/cdc/#create-an-event-source)
to `EventStreamAsync()`:

Expand Down
Loading