Skip to content

Commit dd36634

Browse files
authored
Changes from documentation update (#399)
* Minor typo * Job doc fixes * ServerChildChannel
1 parent da43476 commit dd36634

File tree

4 files changed

+5
-5
lines changed

4 files changed

+5
-5
lines changed

Sources/HummingbirdCore/Error/HTTPError.swift

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
import HTTPTypes
1616
import NIOCore
1717

18-
/// Default HTTP error. Provides an HTTP status and a message is so desired
18+
/// Default HTTP error. Provides an HTTP status and a message
1919
public struct HTTPError: Error, HTTPResponseError, Sendable {
2020
/// status code for the error
2121
public var status: HTTPResponse.Status

Sources/HummingbirdCore/Server/HTTP/HTTPChannelBuilder.swift

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ import NIOCore
1717
/// Build Channel Setup that takes an HTTP responder
1818
///
1919
/// Used when building an ``Hummingbird/Application``. It delays the building
20-
/// of the ``ChildChannel`` until the HTTP responder has been built.
20+
/// of the ``ServerChildChannel`` until the HTTP responder has been built.
2121
public struct HTTPChannelBuilder<ChildChannel: ServerChildChannel>: Sendable {
2222
/// build child channel from HTTP responder
2323
public let build: @Sendable (@escaping HTTPChannelHandler.Responder) throws -> ChildChannel

Sources/HummingbirdJobs/Job.swift

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
//===----------------------------------------------------------------------===//
1414

1515
/// Protocol for a Job
16-
public protocol Job: Sendable {
16+
protocol Job: Sendable {
1717
/// Parameters job requries
1818
associatedtype Parameters: Codable & Sendable
1919
/// Job Type identifier

Sources/HummingbirdJobs/JobQueue.swift

+2-2
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@ import ServiceLifecycle
2222
///
2323
/// Wrapper type to bring together a job queue implementation and a job queue
2424
/// handler. Before you can push jobs onto a queue you should register it
25-
/// with the queue via either ``JobQueue.registerJob(id:maxRetryCount:execute:)`` or
26-
/// ``JobQueue.registerJob(_:)``.
25+
/// with the queue via either ``registerJob(id:maxRetryCount:execute:)`` or
26+
/// ``registerJob(_:)``.
2727
public struct JobQueue<Queue: JobQueueDriver>: Service {
2828
/// underlying driver for queue
2929
public let queue: Queue

0 commit comments

Comments
 (0)