A bit more documentation and some more whitespace changes

Author: mattpolzin

Sources/OpenAPIKit/Either/Either.swift

@@ -18,6 +18,14 @@ public enum Either<A, B> {
 	case a(A)
 	case b(B)
 
+    /// Get the first of the possible values of the `Either` (if it is
+    /// set).
+    ///
+    /// This is sometimes known as the `Left` or error case of some
+    /// `Either` types, but `OpenAPIKit` makes regular use of
+    /// this type in situations where neither of the possible values could
+    /// be considered an error. In fact, `OpenAPIKit` sticks to using
+    /// the Swift `Result` type where such semantics are needed.
 	public var a: A? {
 		guard case let .a(ret) = self else { return nil }
 		return ret
@@ -27,6 +35,8 @@ public enum Either<A, B> {
 		self = .a(a)
 	}
 
+    /// Get the second of the possible values of the `Either` (if
+    /// it is set).
 	public var b: B? {
 		guard case let .b(ret) = self else { return nil }
 		return ret

Sources/OpenAPIKit/Header/Header.swift

@@ -103,9 +103,11 @@ extension OpenAPI.Header {
 
 // MARK: - Header Convenience
 extension OpenAPI.Parameter.SchemaContext {
-    public static func header(_ schema: JSONSchema,
-                              allowReserved: Bool = false,
-                              example: AnyCodable? = nil) -> Self {
+    public static func header(
+        _ schema: JSONSchema,
+        allowReserved: Bool = false,
+        example: AnyCodable? = nil
+    ) -> Self {
         return .init(
             schema,
             style: .default(for: .header),
@@ -114,9 +116,11 @@ extension OpenAPI.Parameter.SchemaContext {
         )
     }
 
-    public static func header(schemaReference: JSONReference<JSONSchema>,
-                              allowReserved: Bool = false,
-                              example: AnyCodable? = nil) -> Self {
+    public static func header(
+        schemaReference: JSONReference<JSONSchema>,
+        allowReserved: Bool = false,
+        example: AnyCodable? = nil
+    ) -> Self {
         return .init(
             schemaReference: schemaReference,
             style: .default(for: .header),
@@ -125,9 +129,11 @@ extension OpenAPI.Parameter.SchemaContext {
         )
     }
 
-    public static func header(_ schema: JSONSchema,
-                              allowReserved: Bool = false,
-                              examples: OpenAPI.Example.Map?) -> Self {
+    public static func header(
+        _ schema: JSONSchema,
+        allowReserved: Bool = false,
+        examples: OpenAPI.Example.Map?
+    ) -> Self {
         return .init(
             schema,
             style: .default(for: .header),
@@ -136,9 +142,11 @@ extension OpenAPI.Parameter.SchemaContext {
         )
     }
 
-    public static func header(schemaReference: JSONReference<JSONSchema>,
-                              allowReserved: Bool = false,
-                              examples: OpenAPI.Example.Map?) -> Self {
+    public static func header(
+        schemaReference: JSONReference<JSONSchema>,
+        allowReserved: Bool = false,
+        examples: OpenAPI.Example.Map?
+    ) -> Self {
         return .init(
             schemaReference: schemaReference,
             style: .default(for: .header),

Sources/OpenAPIKit/OrderedDictionary/OrderedDictionary.swift

@@ -26,7 +26,10 @@ public struct OrderedDictionary<Key, Value> where Key: Hashable {
         unorderedHash = [:]
     }
 
-    public init<S>(grouping values: S, by keyForValue: (S.Element) throws -> Key) rethrows where Value == [S.Element], S : Sequence {
+    public init<S>(
+        grouping values: S,
+        by keyForValue: (S.Element) throws -> Key
+    ) rethrows where Value == [S.Element], S : Sequence {
         var temporaryDictionary = Self()
 
         for value in values {
@@ -35,7 +38,10 @@ public struct OrderedDictionary<Key, Value> where Key: Hashable {
         self = temporaryDictionary
     }
 
-    public init<S>(_ keysAndValues: S, uniquingKeysWith combine: (Value, Value) throws -> Value) rethrows where S : Sequence, S.Element == (Key, Value) {
+    public init<S>(
+        _ keysAndValues: S,
+        uniquingKeysWith combine: (Value, Value) throws -> Value
+    ) rethrows where S : Sequence, S.Element == (Key, Value) {
         var temporaryDictionary = Self()
 
         for (key, value) in keysAndValues {