Add .spi.yml

.spi.yml

@@ -0,0 +1,4 @@
+version: 1
+builder:
+  configs:
+    - documentation_targets: [Strix]

Sources/Strix/Parsers/CharacterParsers.swift

@@ -15,6 +15,7 @@ extension Parser where T == Character {
         }
     }
 
+    /// Use the ``satisfy(_:_:)`` instead.
     @available(*, deprecated, renamed: "satisfy(_:_:)")
     public static func satisfy(
         _ predicate: @escaping (Character) -> Bool,

Sources/Strix/Parsers/Operators.swift

@@ -7,27 +7,27 @@ infix operator <?> : AdditionPrecedence     // one with label
 infix operator <!> : AdditionPrecedence     // print
 
 extension Parser {
-    /// `lhs <|> rhs` is equivalent to `alternative(lhs, rhs)`.
+    /// This operator is equivalent to ``alternative(_:_:)``.
     public static func <|> (lhs: Parser<T>, rhs: Parser<T>) -> Parser<T> {
         return alternative(lhs, rhs)
     }
 
-    /// `lhs *> rhs` is equivalent to `discardFirst(lhs, rhs)`.
+    /// This operator is equivalent to ``discardFirst(_:_:)``.
     public static func *> <U>(lhs: Parser<U>, rhs: Parser<T>) -> Parser<T> {
         return discardFirst(lhs, rhs)
     }
 
-    /// `lhs <* rhs` is equivalent to `discardSecond(lhs, rhs)`.
+    /// This operator is equivalent to ``discardSecond(_:_:)``.
     public static func <* <U>(lhs: Parser<T>, rhs: Parser<U>) -> Parser<T> {
         return discardSecond(lhs, rhs)
     }
 
-    /// `p <?> label` is equivalent to `p.label(label)`.
+    /// This operator is equivalent to ``label(_:)``.
     public static func <?> (p: Parser<T>, label: String) -> Parser<T> {
         return p.label(label)
     }
 
-    /// `p <!> label` is equivalent to `p.print(label)`.
+    /// This operator is equivalent to ``print(_:to:)`` with `nil` output stream.
     public static func <!> (p: Parser<T>, label: String) -> Parser<T> {
         return p.print(label)
     }

Sources/Strix/Parsers/PrimitiveParsers.swift

@@ -140,6 +140,7 @@ extension Parser {
         }
     }
 
+    /// Use the ``one(of:)`` instead.
     @available(*, deprecated, renamed: "one(of:)")
     public static func any<S: Sequence>(of parsers: S) -> Parser<T> where S.Element == Parser<T> {
         return one(of: parsers)
@@ -329,6 +330,7 @@ extension Parser where T == Void {
         }
     }
 
+    /// Use the ``satisfyUserInfo(_:_:)`` instead.
     @available(*, deprecated, renamed: "satisfyUserInfo(_:_:)")
     public static func satisfyUserInfo(
         _ predicate: @escaping (UserInfo) -> Bool,