docs: Update scaladoc

Iltotore · Dec 31, 2021 · 27c5cf5 · 27c5cf5
1 parent 5e7d5fc
commit 27c5cf5
Show file tree

Hide file tree

Showing 119 changed files with 290 additions and 274 deletions.
diff --git a/docs/scaladoc/api/_empty_.html b/docs/scaladoc/api/_empty_.html
diff --git a/docs/scaladoc/api/_empty_/Main$$Account$.html b/docs/scaladoc/api/_empty_/Main$$Account$.html
diff --git a/docs/scaladoc/api/_empty_/Main$$Account.html b/docs/scaladoc/api/_empty_/Main$$Account.html
diff --git a/docs/scaladoc/api/_empty_/Main$.html b/docs/scaladoc/api/_empty_/Main$.html
diff --git a/docs/scaladoc/api/_empty_/testAccount.html b/docs/scaladoc/api/_empty_/testAccount.html
diff --git a/docs/scaladoc/api/index.html b/docs/scaladoc/api/index.html
diff --git a/docs/scaladoc/api/io/github/iltotore/iron.html b/docs/scaladoc/api/io/github/iltotore/iron.html
diff --git a/docs/scaladoc/api/io/github/iltotore/iron/Constrained$.html b/docs/scaladoc/api/io/github/iltotore/iron/Constrained$.html
diff --git a/docs/scaladoc/api/io/github/iltotore/iron/Main$.html b/docs/scaladoc/api/io/github/iltotore/iron/Main$.html
diff --git a/docs/scaladoc/api/io/github/iltotore/iron/RefinedDSL$.html b/docs/scaladoc/api/io/github/iltotore/iron/RefinedDSL$.html
diff --git a/docs/scaladoc/api/io/github/iltotore/iron/catsSupport.html b/docs/scaladoc/api/io/github/iltotore/iron/catsSupport.html
diff --git a/docs/scaladoc/api/io/github/iltotore/iron/circeSupport.html b/docs/scaladoc/api/io/github/iltotore/iron/circeSupport.html
diff --git a/docs/scaladoc/api/io/github/iltotore/iron/compileTime$.html b/docs/scaladoc/api/io/github/iltotore/iron/compileTime$.html
diff --git a/docs/scaladoc/api/io/github/iltotore/iron/constraint.html b/docs/scaladoc/api/io/github/iltotore/iron/constraint.html
diff --git a/docs/scaladoc/api/io/github/iltotore/iron/constraint/AlgebaricAndConstraint.html b/docs/scaladoc/api/io/github/iltotore/iron/constraint/AlgebaricAndConstraint.html
diff --git a/docs/scaladoc/api/io/github/iltotore/iron/constraint/AlgebraEntryPoint.html b/docs/scaladoc/api/io/github/iltotore/iron/constraint/AlgebraEntryPoint.html
diff --git a/docs/scaladoc/api/io/github/iltotore/iron/constraint/AlgebraPart.html b/docs/scaladoc/api/io/github/iltotore/iron/constraint/AlgebraPart.html
diff --git a/docs/scaladoc/api/io/github/iltotore/iron/constraint/AlgebraPartAnd.html b/docs/scaladoc/api/io/github/iltotore/iron/constraint/AlgebraPartAnd.html
diff --git a/docs/scaladoc/api/io/github/iltotore/iron/constraint/AlgebraicConstraint.html b/docs/scaladoc/api/io/github/iltotore/iron/constraint/AlgebraicConstraint.html
diff --git a/docs/scaladoc/api/io/github/iltotore/iron/constraint/And.html b/docs/scaladoc/api/io/github/iltotore/iron/constraint/And.html
diff --git a/docs/scaladoc/api/io/github/iltotore/iron/constraint/AndConstraint.html b/docs/scaladoc/api/io/github/iltotore/iron/constraint/AndConstraint.html
diff --git a/docs/scaladoc/api/io/github/iltotore/iron/constraint/AntiSymmetric.html b/docs/scaladoc/api/io/github/iltotore/iron/constraint/AntiSymmetric.html
diff --git a/docs/scaladoc/api/io/github/iltotore/iron/constraint/Antisymmetric.html b/docs/scaladoc/api/io/github/iltotore/iron/constraint/Antisymmetric.html
diff --git a/docs/scaladoc/api/io/github/iltotore/iron/constraint/Asymmetric.html b/docs/scaladoc/api/io/github/iltotore/iron/constraint/Asymmetric.html
diff --git a/docs/scaladoc/api/io/github/iltotore/iron/constraint/CompileTimeConstraint.html b/docs/scaladoc/api/io/github/iltotore/iron/constraint/CompileTimeConstraint.html
diff --git a/docs/scaladoc/api/io/github/iltotore/iron/constraint/CompileTimeOnly.html b/docs/scaladoc/api/io/github/iltotore/iron/constraint/CompileTimeOnly.html
diff --git a/docs/scaladoc/api/io/github/iltotore/iron/constraint/Consequence$$InvalidConsequence.html b/docs/scaladoc/api/io/github/iltotore/iron/constraint/Consequence$$InvalidConsequence.html
diff --git a/docs/scaladoc/api/io/github/iltotore/iron/constraint/Consequence$$VerifiedConsequence.html b/docs/scaladoc/api/io/github/iltotore/iron/constraint/Consequence$$VerifiedConsequence.html
diff --git a/docs/scaladoc/api/io/github/iltotore/iron/constraint/Consequence$.html b/docs/scaladoc/api/io/github/iltotore/iron/constraint/Consequence$.html
diff --git a/docs/scaladoc/api/io/github/iltotore/iron/constraint/Consequence.html b/docs/scaladoc/api/io/github/iltotore/iron/constraint/Consequence.html
diff --git a/docs/scaladoc/api/io/github/iltotore/iron/constraint/Constraint$$CompileTimeOnly.html b/docs/scaladoc/api/io/github/iltotore/iron/constraint/Constraint$$CompileTimeOnly.html
diff --git a/docs/scaladoc/api/io/github/iltotore/iron/constraint/Constraint$$RuntimeOnly.html b/docs/scaladoc/api/io/github/iltotore/iron/constraint/Constraint$$RuntimeOnly.html
diff --git a/docs/scaladoc/api/io/github/iltotore/iron/constraint/Constraint$.html b/docs/scaladoc/api/io/github/iltotore/iron/constraint/Constraint$.html
diff --git a/docs/scaladoc/api/io/github/iltotore/iron/constraint/Constraint.html b/docs/scaladoc/api/io/github/iltotore/iron/constraint/Constraint.html
diff --git a/docs/scaladoc/api/io/github/iltotore/iron/constraint/DescribedAs.html b/docs/scaladoc/api/io/github/iltotore/iron/constraint/DescribedAs.html
diff --git a/docs/scaladoc/api/io/github/iltotore/iron/constraint/DescribedAsConstraint.html b/docs/scaladoc/api/io/github/iltotore/iron/constraint/DescribedAsConstraint.html
diff --git a/docs/scaladoc/api/io/github/iltotore/iron/constraint/Equal.html b/docs/scaladoc/api/io/github/iltotore/iron/constraint/Equal.html
diff --git a/docs/scaladoc/api/io/github/iltotore/iron/constraint/EqualConstraint.html b/docs/scaladoc/api/io/github/iltotore/iron/constraint/EqualConstraint.html
diff --git a/docs/scaladoc/api/io/github/iltotore/iron/constraint/Equivalence.html b/docs/scaladoc/api/io/github/iltotore/iron/constraint/Equivalence.html
diff --git a/docs/scaladoc/api/io/github/iltotore/iron/constraint/IllegalValueError$$Field.html b/docs/scaladoc/api/io/github/iltotore/iron/constraint/IllegalValueError$$Field.html
diff --git a/docs/scaladoc/api/io/github/iltotore/iron/constraint/IllegalValueError$.html b/docs/scaladoc/api/io/github/iltotore/iron/constraint/IllegalValueError$.html
diff --git a/docs/scaladoc/api/io/github/iltotore/iron/constraint/IllegalValueError.html b/docs/scaladoc/api/io/github/iltotore/iron/constraint/IllegalValueError.html
diff --git a/docs/scaladoc/api/io/github/iltotore/iron/constraint/Literal.html b/docs/scaladoc/api/io/github/iltotore/iron/constraint/Literal.html
diff --git a/docs/scaladoc/api/io/github/iltotore/iron/constraint/LiteralConstraint.html b/docs/scaladoc/api/io/github/iltotore/iron/constraint/LiteralConstraint.html
diff --git a/...doc/api/io/github/iltotore/iron/constraint/LowPriorityConsequence$DefaultConsequence.html b/...doc/api/io/github/iltotore/iron/constraint/LowPriorityConsequence$DefaultConsequence.html
diff --git a/docs/scaladoc/api/io/github/iltotore/iron/constraint/LowPriorityConsequence.html b/docs/scaladoc/api/io/github/iltotore/iron/constraint/LowPriorityConsequence.html
diff --git a/docs/scaladoc/api/io/github/iltotore/iron/constraint/Not.html b/docs/scaladoc/api/io/github/iltotore/iron/constraint/Not.html
diff --git a/docs/scaladoc/api/io/github/iltotore/iron/constraint/NotConstraint.html b/docs/scaladoc/api/io/github/iltotore/iron/constraint/NotConstraint.html
diff --git a/docs/scaladoc/api/io/github/iltotore/iron/constraint/Or.html b/docs/scaladoc/api/io/github/iltotore/iron/constraint/Or.html
diff --git a/docs/scaladoc/api/io/github/iltotore/iron/constraint/OrConstraint.html b/docs/scaladoc/api/io/github/iltotore/iron/constraint/OrConstraint.html
diff --git a/docs/scaladoc/api/io/github/iltotore/iron/constraint/Order.html b/docs/scaladoc/api/io/github/iltotore/iron/constraint/Order.html
diff --git a/docs/scaladoc/api/io/github/iltotore/iron/constraint/Placehold.html b/docs/scaladoc/api/io/github/iltotore/iron/constraint/Placehold.html
diff --git a/docs/scaladoc/api/io/github/iltotore/iron/constraint/PlaceholdConstraint.html b/docs/scaladoc/api/io/github/iltotore/iron/constraint/PlaceholdConstraint.html
diff --git a/docs/scaladoc/api/io/github/iltotore/iron/constraint/Placeholder.html b/docs/scaladoc/api/io/github/iltotore/iron/constraint/Placeholder.html
diff --git a/docs/scaladoc/api/io/github/iltotore/iron/constraint/PlaceholderConstraint.html b/docs/scaladoc/api/io/github/iltotore/iron/constraint/PlaceholderConstraint.html
diff --git a/docs/scaladoc/api/io/github/iltotore/iron/constraint/Reflexive.html b/docs/scaladoc/api/io/github/iltotore/iron/constraint/Reflexive.html
diff --git a/docs/scaladoc/api/io/github/iltotore/iron/constraint/RuntimeOnly.html b/docs/scaladoc/api/io/github/iltotore/iron/constraint/RuntimeOnly.html
diff --git a/docs/scaladoc/api/io/github/iltotore/iron/constraint/RuntimeOnlyConstraint.html b/docs/scaladoc/api/io/github/iltotore/iron/constraint/RuntimeOnlyConstraint.html
diff --git a/docs/scaladoc/api/io/github/iltotore/iron/constraint/StrictEqual.html b/docs/scaladoc/api/io/github/iltotore/iron/constraint/StrictEqual.html
diff --git a/docs/scaladoc/api/io/github/iltotore/iron/constraint/StrictEqualConstraint.html b/docs/scaladoc/api/io/github/iltotore/iron/constraint/StrictEqualConstraint.html
diff --git a/docs/scaladoc/api/io/github/iltotore/iron/constraint/Symmetric.html b/docs/scaladoc/api/io/github/iltotore/iron/constraint/Symmetric.html
diff --git a/docs/scaladoc/api/io/github/iltotore/iron/constraint/Transitive.html b/docs/scaladoc/api/io/github/iltotore/iron/constraint/Transitive.html
diff --git a/docs/scaladoc/api/io/github/iltotore/iron/constraint/TransitiveConsequence.html b/docs/scaladoc/api/io/github/iltotore/iron/constraint/TransitiveConsequence.html
diff --git a/docs/scaladoc/api/io/github/iltotore/iron/ioSupport.html b/docs/scaladoc/api/io/github/iltotore/iron/ioSupport.html
diff --git a/docs/scaladoc/api/io/github/iltotore/iron/ioSupport/constraint$$Exists.html b/docs/scaladoc/api/io/github/iltotore/iron/ioSupport/constraint$$Exists.html
diff --git a/docs/scaladoc/api/io/github/iltotore/iron/ioSupport/constraint$$IsDirectory.html b/docs/scaladoc/api/io/github/iltotore/iron/ioSupport/constraint$$IsDirectory.html
diff --git a/docs/scaladoc/api/io/github/iltotore/iron/ioSupport/constraint$$IsFile.html b/docs/scaladoc/api/io/github/iltotore/iron/ioSupport/constraint$$IsFile.html
diff --git a/...doc/api/io/github/iltotore/iron/ioSupport/constraint$$given_RuntimeOnly_File_Exists$.html b/...doc/api/io/github/iltotore/iron/ioSupport/constraint$$given_RuntimeOnly_File_Exists$.html
diff --git a/...pi/io/github/iltotore/iron/ioSupport/constraint$$given_RuntimeOnly_File_IsDirectory$.html b/...pi/io/github/iltotore/iron/ioSupport/constraint$$given_RuntimeOnly_File_IsDirectory$.html
diff --git a/...doc/api/io/github/iltotore/iron/ioSupport/constraint$$given_RuntimeOnly_File_IsFile$.html b/...doc/api/io/github/iltotore/iron/ioSupport/constraint$$given_RuntimeOnly_File_IsFile$.html
diff --git a/...doc/api/io/github/iltotore/iron/ioSupport/constraint$$given_RuntimeOnly_Path_Exists$.html b/...doc/api/io/github/iltotore/iron/ioSupport/constraint$$given_RuntimeOnly_Path_Exists$.html
diff --git a/...pi/io/github/iltotore/iron/ioSupport/constraint$$given_RuntimeOnly_Path_IsDirectory$.html b/...pi/io/github/iltotore/iron/ioSupport/constraint$$given_RuntimeOnly_Path_IsDirectory$.html
diff --git a/...doc/api/io/github/iltotore/iron/ioSupport/constraint$$given_RuntimeOnly_Path_IsFile$.html b/...doc/api/io/github/iltotore/iron/ioSupport/constraint$$given_RuntimeOnly_Path_IsFile$.html
diff --git a/...c/api/io/github/iltotore/iron/ioSupport/constraint$$given_RuntimeOnly_String_Exists$.html b/...c/api/io/github/iltotore/iron/ioSupport/constraint$$given_RuntimeOnly_String_Exists$.html
diff --git a/.../io/github/iltotore/iron/ioSupport/constraint$$given_RuntimeOnly_String_IsDirectory$.html b/.../io/github/iltotore/iron/ioSupport/constraint$$given_RuntimeOnly_String_IsDirectory$.html
diff --git a/...c/api/io/github/iltotore/iron/ioSupport/constraint$$given_RuntimeOnly_String_IsFile$.html b/...c/api/io/github/iltotore/iron/ioSupport/constraint$$given_RuntimeOnly_String_IsFile$.html
diff --git a/docs/scaladoc/api/io/github/iltotore/iron/ioSupport/constraint$.html b/docs/scaladoc/api/io/github/iltotore/iron/ioSupport/constraint$.html
diff --git a/docs/scaladoc/api/io/github/iltotore/iron/iterable.html b/docs/scaladoc/api/io/github/iltotore/iron/iterable.html
diff --git a/docs/scaladoc/api/io/github/iltotore/iron/iterable/constraint$$Contains.html b/docs/scaladoc/api/io/github/iltotore/iron/iterable/constraint$$Contains.html
diff --git a/docs/scaladoc/api/io/github/iltotore/iron/iterable/constraint$$MaxSize.html b/docs/scaladoc/api/io/github/iltotore/iron/iterable/constraint$$MaxSize.html
diff --git a/docs/scaladoc/api/io/github/iltotore/iron/iterable/constraint$$MinSize.html b/docs/scaladoc/api/io/github/iltotore/iron/iterable/constraint$$MinSize.html
diff --git a/docs/scaladoc/api/io/github/iltotore/iron/iterable/constraint$$Size.html b/docs/scaladoc/api/io/github/iltotore/iron/iterable/constraint$$Size.html
diff --git a/...aladoc/api/io/github/iltotore/iron/iterable/constraint$$given_RuntimeOnly_A_Contains.html b/...aladoc/api/io/github/iltotore/iron/iterable/constraint$$given_RuntimeOnly_A_Contains.html
diff --git a/...caladoc/api/io/github/iltotore/iron/iterable/constraint$$given_RuntimeOnly_A_MaxSize.html b/...caladoc/api/io/github/iltotore/iron/iterable/constraint$$given_RuntimeOnly_A_MaxSize.html
diff --git a/...caladoc/api/io/github/iltotore/iron/iterable/constraint$$given_RuntimeOnly_A_MinSize.html b/...caladoc/api/io/github/iltotore/iron/iterable/constraint$$given_RuntimeOnly_A_MinSize.html
diff --git a/docs/scaladoc/api/io/github/iltotore/iron/iterable/constraint$$given_RuntimeOnly_A_Size.html b/docs/scaladoc/api/io/github/iltotore/iron/iterable/constraint$$given_RuntimeOnly_A_Size.html
diff --git a/docs/scaladoc/api/io/github/iltotore/iron/iterable/constraint$.html b/docs/scaladoc/api/io/github/iltotore/iron/iterable/constraint$.html
diff --git a/docs/scaladoc/api/io/github/iltotore/iron/numeric.html b/docs/scaladoc/api/io/github/iltotore/iron/numeric.html
diff --git a/docs/scaladoc/api/io/github/iltotore/iron/numeric/Main$.html b/docs/scaladoc/api/io/github/iltotore/iron/numeric/Main$.html
diff --git a/docs/scaladoc/api/io/github/iltotore/iron/numeric/NumberOrdering$.html b/docs/scaladoc/api/io/github/iltotore/iron/numeric/NumberOrdering$.html
diff --git a/docs/scaladoc/api/io/github/iltotore/iron/numeric/constraint$$Divide.html b/docs/scaladoc/api/io/github/iltotore/iron/numeric/constraint$$Divide.html
diff --git a/docs/scaladoc/api/io/github/iltotore/iron/numeric/constraint$$DivideConstraint.html b/docs/scaladoc/api/io/github/iltotore/iron/numeric/constraint$$DivideConstraint.html
diff --git a/docs/scaladoc/api/io/github/iltotore/iron/numeric/constraint$$Divisible.html b/docs/scaladoc/api/io/github/iltotore/iron/numeric/constraint$$Divisible.html
diff --git a/docs/scaladoc/api/io/github/iltotore/iron/numeric/constraint$$DivisibleConstraint.html b/docs/scaladoc/api/io/github/iltotore/iron/numeric/constraint$$DivisibleConstraint.html
diff --git a/docs/scaladoc/api/io/github/iltotore/iron/numeric/constraint$$Greater.html b/docs/scaladoc/api/io/github/iltotore/iron/numeric/constraint$$Greater.html
diff --git a/docs/scaladoc/api/io/github/iltotore/iron/numeric/constraint$$GreaterConstraint.html b/docs/scaladoc/api/io/github/iltotore/iron/numeric/constraint$$GreaterConstraint.html
diff --git a/docs/scaladoc/api/io/github/iltotore/iron/numeric/constraint$$GreaterEqual.html b/docs/scaladoc/api/io/github/iltotore/iron/numeric/constraint$$GreaterEqual.html
diff --git a/docs/scaladoc/api/io/github/iltotore/iron/numeric/constraint$$GreaterEqualConstraint.html b/docs/scaladoc/api/io/github/iltotore/iron/numeric/constraint$$GreaterEqualConstraint.html
diff --git a/docs/scaladoc/api/io/github/iltotore/iron/numeric/constraint$$Less.html b/docs/scaladoc/api/io/github/iltotore/iron/numeric/constraint$$Less.html
diff --git a/docs/scaladoc/api/io/github/iltotore/iron/numeric/constraint$$LessConstraint.html b/docs/scaladoc/api/io/github/iltotore/iron/numeric/constraint$$LessConstraint.html
diff --git a/docs/scaladoc/api/io/github/iltotore/iron/numeric/constraint$$LessEqual.html b/docs/scaladoc/api/io/github/iltotore/iron/numeric/constraint$$LessEqual.html
diff --git a/docs/scaladoc/api/io/github/iltotore/iron/numeric/constraint$$LessEqualConstraint.html b/docs/scaladoc/api/io/github/iltotore/iron/numeric/constraint$$LessEqualConstraint.html
diff --git a/docs/scaladoc/api/io/github/iltotore/iron/numeric/constraint$$MathAlgebra.html b/docs/scaladoc/api/io/github/iltotore/iron/numeric/constraint$$MathAlgebra.html
diff --git a/docs/scaladoc/api/io/github/iltotore/iron/numeric/constraint$.html b/docs/scaladoc/api/io/github/iltotore/iron/numeric/constraint$.html
diff --git a/docs/scaladoc/api/io/github/iltotore/iron/numeric/testMain.html b/docs/scaladoc/api/io/github/iltotore/iron/numeric/testMain.html
diff --git a/docs/scaladoc/api/io/github/iltotore/iron/ordering.html b/docs/scaladoc/api/io/github/iltotore/iron/ordering.html
diff --git a/docs/scaladoc/api/io/github/iltotore/iron/ordering/InlinedOrdering.html b/docs/scaladoc/api/io/github/iltotore/iron/ordering/InlinedOrdering.html
diff --git a/docs/scaladoc/api/io/github/iltotore/iron/string.html b/docs/scaladoc/api/io/github/iltotore/iron/string.html
diff --git a/docs/scaladoc/api/io/github/iltotore/iron/string/constraint$$LowerCase.html b/docs/scaladoc/api/io/github/iltotore/iron/string/constraint$$LowerCase.html
diff --git a/docs/scaladoc/api/io/github/iltotore/iron/string/constraint$$Match.html b/docs/scaladoc/api/io/github/iltotore/iron/string/constraint$$Match.html
diff --git a/docs/scaladoc/api/io/github/iltotore/iron/string/constraint$$UpperCase.html b/docs/scaladoc/api/io/github/iltotore/iron/string/constraint$$UpperCase.html
diff --git a/...c/api/io/github/iltotore/iron/string/constraint$$given_RuntimeOnly_String_LowerCase$.html b/...c/api/io/github/iltotore/iron/string/constraint$$given_RuntimeOnly_String_LowerCase$.html
diff --git a/...aladoc/api/io/github/iltotore/iron/string/constraint$$given_RuntimeOnly_String_Match.html b/...aladoc/api/io/github/iltotore/iron/string/constraint$$given_RuntimeOnly_String_Match.html
diff --git a/...c/api/io/github/iltotore/iron/string/constraint$$given_RuntimeOnly_String_UpperCase$.html b/...c/api/io/github/iltotore/iron/string/constraint$$given_RuntimeOnly_String_UpperCase$.html
diff --git a/docs/scaladoc/api/io/github/iltotore/iron/string/constraint$.html b/docs/scaladoc/api/io/github/iltotore/iron/string/constraint$.html
diff --git a/docs/scaladoc/api/io/github/iltotore/iron/testMain.html b/docs/scaladoc/api/io/github/iltotore/iron/testMain.html
diff --git a/docs/scaladoc/index.html b/docs/scaladoc/index.html
diff --git a/docs/scaladoc/scripts/searchData.js b/docs/scaladoc/scripts/searchData.js
diff --git a/main/src/io/github/iltotore/iron/constraint/package.scala b/main/src/io/github/iltotore/iron/constraint/package.scala
@@ -90,8 +90,8 @@ package object constraint extends LowPriorityConsequence {
   transparent inline given [A, V <: A, Sym[_], B[_] <: Antisymmetric[_, Sym]]: Consequence[A, B[V] && Sym[V], StrictEqual[V]] = Consequence.verified
 
   /**
-   * An asymmetric binary relation aRb
-   * @tparam V the value of b
+   * An asymmetric binary relation `aRb`javadoc
+   * @tparam V the value of `b`
    * @tparam Sym the opposite relation (`bRa` <=> `a Sym b`)
    */
   trait Asymmetric[V, Sym[_]]