Skip to content

Fix a few docs #2168

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Jan 21, 2025
Merged

Fix a few docs #2168

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
13 changes: 7 additions & 6 deletions Sources/GRPCCore/GRPCServer.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,8 @@ private import Synchronization
/// The following example demonstrates how to create and run a server.
///
/// ```swift
/// // Create an transport
/// let transport: any ServerTransport = ...
/// // Create a transport
/// let transport = SomeServerTransport()
///
/// // Create the 'Greeter' and 'Echo' services.
/// let greeter = GreeterService()
Expand Down Expand Up @@ -73,7 +73,8 @@ private import Synchronization
/// This allows the server to drain existing requests gracefully. To stop the server more abruptly
/// you can cancel the task running your server. If your application requires additional resources
/// that need their lifecycles managed you should consider using [Swift Service
/// Lifecycle](https://github.com/swift-server/swift-service-lifecycle).
/// Lifecycle](https://github.com/swift-server/swift-service-lifecycle) and the
/// `GRPCServiceLifecycle` module provided by [gRPC Swift Extras](https://github.com/grpc/grpc-swift-extras).
public final class GRPCServer<Transport: ServerTransport>: Sendable {
typealias Stream = RPCStream<Transport.Inbound, Transport.Outbound>

Expand Down Expand Up @@ -136,7 +137,7 @@ public final class GRPCServer<Transport: ServerTransport>: Sendable {
}
}

/// Creates a new server with no resources.
/// Creates a new server.
///
/// - Parameters:
/// - transport: The transport the server should listen on.
Expand All @@ -158,7 +159,7 @@ public final class GRPCServer<Transport: ServerTransport>: Sendable {
)
}

/// Creates a new server with no resources.
/// Creates a new server.
///
/// - Parameters:
/// - transport: The transport the server should listen on.
Expand All @@ -182,7 +183,7 @@ public final class GRPCServer<Transport: ServerTransport>: Sendable {
self.init(transport: transport, router: router)
}

/// Creates a new server with no resources.
/// Creates a new server with a pre-configured router.
///
/// - Parameters:
/// - transport: The transport the server should listen on.
Expand Down
Loading