Skip to content

Commit babdde1

Browse files
committed
Fix docs
1 parent ddcc13a commit babdde1

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed

Sources/GRPCCore/Documentation.docc/Development/Design.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -173,12 +173,12 @@ concurrency.
173173
Most users won't use ``GRPCClient`` to execute RPCs directly, instead they will
174174
use the generated client stubs which wrap the ``GRPCClient``. Users are
175175
responsible for creating the client and running it (which starts and runs the
176-
underlying transport). This is done by calling ``GRPCClient/run()``. The client
176+
underlying transport). This is done by calling ``GRPCClient/runConnections()``. The client
177177
can be shutdown gracefully by calling ``GRPCClient/beginGracefulShutdown()``
178178
which will stop new RPCs from starting (by failing them with
179179
``RPCError/Code-swift.struct/unavailable``) but allow existing ones to continue.
180180
Existing work can be stopped more abruptly by cancelling the task where
181-
``GRPCClient/run()`` is executing.
181+
``GRPCClient/runConnections()`` is executing.
182182

183183
#### Server
184184

Sources/GRPCCore/GRPCClient.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -231,7 +231,7 @@ public final class GRPCClient<Transport: ClientTransport>: Sendable {
231231
///
232232
/// The transport will be closed: this means that it will be given enough time to wait for
233233
/// in-flight RPCs to finish executing, but no new RPCs will be accepted. You can cancel the task
234-
/// executing ``run()`` if you want to abruptly stop in-flight RPCs.
234+
/// executing ``runConnections()`` if you want to abruptly stop in-flight RPCs.
235235
public func beginGracefulShutdown() {
236236
let wasRunning = self.stateMachine.withLock { $0.state.beginGracefulShutdown() }
237237
if wasRunning {

0 commit comments

Comments
 (0)