Tweak the docs on the errors throw.

Don't call out too specific of things and instead just mention the Errors types that are possible to avoid being overly specific and leading folks in the wrong direction.
apple · Aug 24, 2023 · 78a6260 · 78a6260
1 parent 618433a
commit 78a6260
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 14 deletions.
diff --git a/Sources/SwiftProtobuf/AsyncMessageSequence.swift b/Sources/SwiftProtobuf/AsyncMessageSequence.swift
@@ -28,12 +28,9 @@ extension AsyncSequence where Element == UInt8 {
   ///     `BinaryDecodingError.missingRequiredFields` will be thrown.
   ///   - options: The BinaryDecodingOptions to use.
   /// - Returns: An asynchronous sequence of messages read from the `AsyncSequence` of bytes.
-  /// - Throws: `BinaryDecodingError` if decoding fails, throws
-  ///           `BinaryDelimited.Error` for some reading errors,
-  ///           `BinaryDelimited.Error.truncated` if the stream ends before fully decoding a
-  ///           message or a delimiter,
-  ///           `BinaryDelimited.Error.malformedLength`if a delimiter could not be read and
-  ///           `BinaryDecodingError.tooLarge` if a size delimiter of 2GB or greater is found.
+  /// - Throws: `BinaryDelimited.Error` for errors in the framing of the messages
+  ///           in the sequence, `BinaryDecodingError` for errors while decoding
+  ///           messages.
   @inlinable
   public func binaryProtobufDelimitedMessages<M: Message>(
     of messageType: M.Type = M.self,
@@ -78,12 +75,9 @@ public struct AsyncMessageSequence<
   ///     `BinaryDecodingError.missingRequiredFields` will be thrown.
   ///   - options: The BinaryDecodingOptions to use.
   /// - Returns: An asynchronous sequence of messages read from the `AsyncSequence` of bytes.
-  /// - Throws: `BinaryDecodingError` if decoding fails, throws
-  ///           `BinaryDelimited.Error` for some reading errors,
-  ///           `BinaryDelimited.Error.truncated` if the stream ends before fully decoding a
-  ///           message or a delimiter,
-  ///           `BinaryDelimited.Error.malformedLength`if a delimiter could not be read and
-  ///           `BinaryDecodingError.tooLarge` if a size delimiter of 2GB or greater is found.
+  /// - Throws: `BinaryDelimited.Error` for errors in the framing of the messages
+  ///           in the sequence, `BinaryDecodingError` for errors while decoding
+  ///           messages.
   public init(
     base: Base,
     extensions: ExtensionMap? = nil,

diff --git a/Sources/SwiftProtobuf/BinaryDelimited.swift b/Sources/SwiftProtobuf/BinaryDelimited.swift
@@ -123,7 +123,7 @@ public enum BinaryDelimited {
   /// - Returns: The message read.
   /// - Throws: `BinaryDecodingError` if decoding fails, throws
   ///           `BinaryDelimited.Error` for some reading errors, and the
-  ///           underlying InputStream.streamError for a stream error.
+  ///           underlying `InputStream.streamError` for a stream error.
   public static func parse<M: Message>(
     messageType: M.Type,
     from stream: InputStream,
@@ -164,7 +164,7 @@ public enum BinaryDelimited {
   ///   - options: The BinaryDecodingOptions to use.
   /// - Throws: `BinaryDecodingError` if decoding fails, throws
   ///           `BinaryDelimited.Error` for some reading errors, and the
-  ///           underlying InputStream.streamError for a stream error.
+  ///           underlying `InputStream.streamError` for a stream error.
   public static func merge<M: Message>(
     into message: inout M,
     from stream: InputStream,