From a9e8e1f2dc69ed36c28aa2e92f2f96a4e9a60598 Mon Sep 17 00:00:00 2001 From: Liu Liu Date: Sat, 4 Jun 2022 20:10:21 -0400 Subject: [PATCH] Minor fix documentation for some layout issues in docc. --- src/Publisher.swift | 38 +++++++++++++++++++------------------- src/Workspace.swift | 32 ++++++++++++++++---------------- 2 files changed, 35 insertions(+), 35 deletions(-) diff --git a/src/Publisher.swift b/src/Publisher.swift index fcfde5dce..f3d49df97 100644 --- a/src/Publisher.swift +++ b/src/Publisher.swift @@ -35,31 +35,31 @@ open class QueryPublisherBuilder { public init() {} /** - * Subscribe to a query against the Workspace. This is coupled with `publisher(for: Element.self)` method - * and shouldn't be used independently. - * - * - Parameters: - * - query: The query such as `Post.title == "some title" && Post.color == .red` - * - limit: The limit. Default to `.noLimit`, you can supply `.limit(number)` - * - orderBy: The array of keys to order the result. Such as `[Post.priority.descending]` - * - * - Returns: A publisher object that can be interacted with Combine. - */ + * Subscribe to a query against the Workspace. This is coupled with `publisher(for: Element.self)` method + * and shouldn't be used independently. + * + * - Parameters: + * - query: The query such as `Post.title == "some title" && Post.color == .red` + * - limit: The limit. Default to `.noLimit`, you can supply `.limit(number)` + * - orderBy: The array of keys to order the result. Such as `[Post.priority.descending]` + * + * - Returns: A publisher object that can be interacted with Combine. + */ open func `where`( _ query: T, limit: Limit = .noLimit, orderBy: [OrderBy] = [] ) -> QueryPublisher where T.ResultType == Bool, T.Element == Element { fatalError() } /** - * Subscribe to all changes to a class. This is coupled with `publisher(for: Element.self)` method - * and shouldn't be used independently. - * - * - Parameters: - * - limit: The limit. Default to `.noLimit`, you can supply `.limit(number)` - * - orderBy: The array of keys to order the result. Such as `[Post.priority.descending]` - * - * - Returns: A publisher object that can be interacted with Combine. - */ + * Subscribe to all changes to a class. This is coupled with `publisher(for: Element.self)` method + * and shouldn't be used independently. + * + * - Parameters: + * - limit: The limit. Default to `.noLimit`, you can supply `.limit(number)` + * - orderBy: The array of keys to order the result. Such as `[Post.priority.descending]` + * + * - Returns: A publisher object that can be interacted with Combine. + */ open func all(limit: Limit = .noLimit, orderBy: [OrderBy] = []) -> QueryPublisher< Element > { diff --git a/src/Workspace.swift b/src/Workspace.swift index 43e2800ea..c3e30f76c 100644 --- a/src/Workspace.swift +++ b/src/Workspace.swift @@ -169,27 +169,27 @@ public protocol Workspace: Queryable { #endif #if compiler(>=5.5) && canImport(_Concurrency) /** - * Subscribe to changes to the said object, and return the AsyncSequence you can iterate over. - * - * - Parameters: - * - object: The object previously fetched that we want to observe the new updates. - * - bufferingPolicy: The buffering policy to avoid issuing all updates to concerned parties. Default will be the newest of 1. - * - * - Returns: An AsyncSequence that can await for new object updates. Finishes only if the object deletes. - */ + * Subscribe to changes to the said object, and return the AsyncSequence you can iterate over. + * + * - Parameters: + * - object: The object previously fetched that we want to observe the new updates. + * - bufferingPolicy: The buffering policy to avoid issuing all updates to concerned parties. Default will be the newest of 1. + * + * - Returns: An AsyncSequence that can await for new object updates. Finishes only if the object deletes. + */ @available(macOS 12.0, iOS 15.0, tvOS 15.0, watchOS 8.0, *) func subscribe( object: Element, bufferingPolicy: AsyncStream.Continuation.BufferingPolicy ) -> AsyncStream /** - * Subscribe to changes to the said fetched result, and return the AsyncSequence you can iterate over. - * - * - Parameters: - * - fetchedResult: The result fetched that we want to observe the new updates. - * - bufferingPolicy: The buffering policy to avoid issuing all updates to concerned parties. Default will be the newest of 1. - * - * - Returns: An AsyncSequence that can await for new fetched result. It never finishes. - */ + * Subscribe to changes to the said fetched result, and return the AsyncSequence you can iterate over. + * + * - Parameters: + * - fetchedResult: The result fetched that we want to observe the new updates. + * - bufferingPolicy: The buffering policy to avoid issuing all updates to concerned parties. Default will be the newest of 1. + * + * - Returns: An AsyncSequence that can await for new fetched result. It never finishes. + */ @available(macOS 12.0, iOS 15.0, tvOS 15.0, watchOS 8.0, *) func subscribe( fetchedResult: FetchedResult,