From dd3663447be43bb3c813579960715c110c66bb18 Mon Sep 17 00:00:00 2001 From: Adam Fowler Date: Thu, 14 Mar 2024 09:47:53 +0000 Subject: [PATCH] Changes from documentation update (#399) * Minor typo * Job doc fixes * ServerChildChannel --- Sources/HummingbirdCore/Error/HTTPError.swift | 2 +- Sources/HummingbirdCore/Server/HTTP/HTTPChannelBuilder.swift | 2 +- Sources/HummingbirdJobs/Job.swift | 2 +- Sources/HummingbirdJobs/JobQueue.swift | 4 ++-- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/Sources/HummingbirdCore/Error/HTTPError.swift b/Sources/HummingbirdCore/Error/HTTPError.swift index 4f564123a..926758834 100644 --- a/Sources/HummingbirdCore/Error/HTTPError.swift +++ b/Sources/HummingbirdCore/Error/HTTPError.swift @@ -15,7 +15,7 @@ import HTTPTypes import NIOCore -/// Default HTTP error. Provides an HTTP status and a message is so desired +/// Default HTTP error. Provides an HTTP status and a message public struct HTTPError: Error, HTTPResponseError, Sendable { /// status code for the error public var status: HTTPResponse.Status diff --git a/Sources/HummingbirdCore/Server/HTTP/HTTPChannelBuilder.swift b/Sources/HummingbirdCore/Server/HTTP/HTTPChannelBuilder.swift index 6a5291d23..5bd49cad6 100644 --- a/Sources/HummingbirdCore/Server/HTTP/HTTPChannelBuilder.swift +++ b/Sources/HummingbirdCore/Server/HTTP/HTTPChannelBuilder.swift @@ -17,7 +17,7 @@ import NIOCore /// Build Channel Setup that takes an HTTP responder /// /// Used when building an ``Hummingbird/Application``. It delays the building -/// of the ``ChildChannel`` until the HTTP responder has been built. +/// of the ``ServerChildChannel`` until the HTTP responder has been built. public struct HTTPChannelBuilder: Sendable { /// build child channel from HTTP responder public let build: @Sendable (@escaping HTTPChannelHandler.Responder) throws -> ChildChannel diff --git a/Sources/HummingbirdJobs/Job.swift b/Sources/HummingbirdJobs/Job.swift index a992cc178..addf4f451 100644 --- a/Sources/HummingbirdJobs/Job.swift +++ b/Sources/HummingbirdJobs/Job.swift @@ -13,7 +13,7 @@ //===----------------------------------------------------------------------===// /// Protocol for a Job -public protocol Job: Sendable { +protocol Job: Sendable { /// Parameters job requries associatedtype Parameters: Codable & Sendable /// Job Type identifier diff --git a/Sources/HummingbirdJobs/JobQueue.swift b/Sources/HummingbirdJobs/JobQueue.swift index ea2d334ed..b3abf18db 100644 --- a/Sources/HummingbirdJobs/JobQueue.swift +++ b/Sources/HummingbirdJobs/JobQueue.swift @@ -22,8 +22,8 @@ import ServiceLifecycle /// /// Wrapper type to bring together a job queue implementation and a job queue /// handler. Before you can push jobs onto a queue you should register it -/// with the queue via either ``JobQueue.registerJob(id:maxRetryCount:execute:)`` or -/// ``JobQueue.registerJob(_:)``. +/// with the queue via either ``registerJob(id:maxRetryCount:execute:)`` or +/// ``registerJob(_:)``. public struct JobQueue: Service { /// underlying driver for queue public let queue: Queue