Skip to content

Commit 74d0848

Browse files
glbrnttgjcairo
andauthored
Add a design doc (#2079)
Motivation: For library maintainers and some users, having an understanding of how the library is structured is incredibly helpful. Modifications: - Add a high-level design doc linking to the relevant symbols - Fix up a couple of other DocC warnings Result: More docs --------- Co-authored-by: Gus Cairo <[email protected]>
1 parent 5287f05 commit 74d0848

File tree

5 files changed

+452
-5
lines changed

5 files changed

+452
-5
lines changed

Sources/GRPCCore/Call/Client/ClientRequest.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
/// See ``StreamingClientRequest`` for streaming requests and ``ServerRequest`` for the
2222
/// servers representation of a single-message request.
2323
///
24-
/// ## Creating ``Single`` requests
24+
/// ## Creating requests
2525
///
2626
/// ```swift
2727
/// let request = ClientRequest<String>(message: "Hello, gRPC!")

Sources/GRPCCore/Call/Client/ClientResponse.swift

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
/// an ``RPCError`` describing why the RPC failed, including an error code, error message and any
3030
/// metadata sent by the server.
3131
///
32-
/// ### Using ``Single`` responses
32+
/// ### Using responses
3333
///
3434
/// Each response has a ``accepted`` property which contains all RPC information. You can create
3535
/// one by calling ``init(accepted:)`` or one of the two convenience initializers:
@@ -153,7 +153,7 @@ public struct ClientResponse<Message: Sendable>: Sendable {
153153
/// to execute the request. The failure case contains an ``RPCError`` describing why the RPC
154154
/// failed, including an error code, error message and any metadata sent by the server.
155155
///
156-
/// ### Using ``Stream`` responses
156+
/// ### Using streaming responses
157157
///
158158
/// Each response has a ``accepted`` property which contains RPC information. You can create
159159
/// one by calling ``init(accepted:)`` or one of the two convenience initializers:

Sources/GRPCCore/Call/Server/ServerResponse.swift

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
/// of the RPC failed. The failure case contains an ``RPCError`` describing why the RPC failed,
2929
/// including an error code, error message and any metadata sent by the server.
3030
///
31-
/// ### Using ``Single`` responses
31+
/// ### Using responses
3232
///
3333
/// Each response has an ``accepted`` property which contains all RPC information. You can create
3434
/// one by calling ``init(accepted:)`` or one of the two convenience initializers:
@@ -144,7 +144,7 @@ public struct ServerResponse<Message: Sendable>: Sendable {
144144
/// contains an ``RPCError`` describing why the RPC failed, including an error code, error
145145
/// message and any metadata to send to the client.
146146
///
147-
/// ### Using ``Stream`` responses
147+
/// ### Using streaming responses
148148
///
149149
/// Each response has an ``accepted`` property which contains all RPC information. You can create
150150
/// one by calling ``init(accepted:)`` or one of the two convenience initializers:

0 commit comments

Comments
 (0)