Skip to content

Commit 32d17fb

Browse files
authored
Fix a few docs (#2168)
1 parent e4da2bb commit 32d17fb

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

Sources/GRPCCore/GRPCServer.swift

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,8 @@ private import Synchronization
3434
/// The following example demonstrates how to create and run a server.
3535
///
3636
/// ```swift
37-
/// // Create an transport
38-
/// let transport: any ServerTransport = ...
37+
/// // Create a transport
38+
/// let transport = SomeServerTransport()
3939
///
4040
/// // Create the 'Greeter' and 'Echo' services.
4141
/// let greeter = GreeterService()
@@ -73,7 +73,8 @@ private import Synchronization
7373
/// This allows the server to drain existing requests gracefully. To stop the server more abruptly
7474
/// you can cancel the task running your server. If your application requires additional resources
7575
/// that need their lifecycles managed you should consider using [Swift Service
76-
/// Lifecycle](https://github.com/swift-server/swift-service-lifecycle).
76+
/// Lifecycle](https://github.com/swift-server/swift-service-lifecycle) and the
77+
/// `GRPCServiceLifecycle` module provided by [gRPC Swift Extras](https://github.com/grpc/grpc-swift-extras).
7778
public final class GRPCServer<Transport: ServerTransport>: Sendable {
7879
typealias Stream = RPCStream<Transport.Inbound, Transport.Outbound>
7980

@@ -136,7 +137,7 @@ public final class GRPCServer<Transport: ServerTransport>: Sendable {
136137
}
137138
}
138139

139-
/// Creates a new server with no resources.
140+
/// Creates a new server.
140141
///
141142
/// - Parameters:
142143
/// - transport: The transport the server should listen on.
@@ -158,7 +159,7 @@ public final class GRPCServer<Transport: ServerTransport>: Sendable {
158159
)
159160
}
160161

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

185-
/// Creates a new server with no resources.
186+
/// Creates a new server with a pre-configured router.
186187
///
187188
/// - Parameters:
188189
/// - transport: The transport the server should listen on.

0 commit comments

Comments
 (0)