[docs] update vale to v3.0.5 (#2403)

Author: odow

.github/workflows/documentation.yml

@@ -33,11 +33,10 @@ jobs:
           path: ${{ github.workspace }}/latex-debug-logs
       - uses: errata-ai/vale-action@reviewdog
         with:
-          # TODO(odow): at some point, update to vale@3
-          version: 2.30.0
-          files: docs/src
+          version: 3.0.5
+          files: all
           fail_on_error: true
           filter_mode: nofilter
-          vale_flags: "--config=docs/.vale.ini"
+          vale_flags: "--config=.vale.ini"
         env:
           GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}

.vale.ini

@@ -0,0 +1,22 @@
+StylesPath = docs/styles
+MinAlertLevel = warning
+
+Vocab = JuMP
+
+[*.jl]
+BasedOnStyles = Vale, Google
+
+# TODO(odow): fix all of these
+Google.Ellipses = OFF
+Google.Exclamation = OFF
+Google.FirstPerson = OFF
+Google.OptionalPlurals = OFF
+Google.Units = OFF
+Vale.Spelling = OFF
+
+[*.md]
+BasedOnStyles = Vale, Google
+
+[*]
+TokenIgnores = (\$.+?\$), \]\(@(ref|id).+?\)
+Google.Quotes = OFF

docs/.vale.ini

@@ -149,8 +149,8 @@ write(joinpath(@__DIR__, "src", "MathOptInterface.pdf"), "")
     linkcheck_ignore = [
         # Ignore the PDF link, because it hasn't been built yet.
         "MathOptInterface.pdf",
-        # Ignore tags, because preping for a new release will otherwise cause it
-        # to fail.
+        # Ignore tags, because prepping for a new release will otherwise cause
+        # it to fail.
         r"https://github.com/jump-dev/MathOptInterface.jl/releases/tag/v([0-9]).([0-9]+).([0-9]+)",
         # Ignore issue and pull request links, because there are many of them,
         # and they sometimes time-out the linkcheck.
@@ -178,8 +178,8 @@ if _PDF
         build = "latex_build",
         pages = _PAGES,
     )
-    # Hack for deploying: copy the pdf (and only the PDF) into the HTML build
-    # directory! We don't want to copy everything in `latex_build` because it
+    # Hack for deploying: copy the PDF (and only the PDF) into the HTML build
+    # directory. We don't want to copy everything in `latex_build` because it
     # includes lots of extraneous LaTeX files.
     cp(
         joinpath(@__DIR__, "latex_build", "MathOptInterface.pdf"),

docs/make.jl

@@ -7,13 +7,17 @@ bugfixe(?s)
 datastructure
 docstring(?s)
 doctest
-enum
+[Ee]num
 errored
 flamegraph
 getters
 [Jj]ulia
+linkcheck
+nonlinearly
 [Pp]recompil(ation|(e(?d)))
 subexpression(?s)
+sublicense
+textualist
 
 % JuMP-related vocab
 [Cc]anonicaliz(e|ation|ing)
@@ -27,6 +31,7 @@ unboundedness
 [Un]nivariate
 
 % Other
+Codecov
 Clp
 Gurobi
 GZip
@@ -35,3 +40,4 @@ JSONSchema
 MOI
 PATHSolver
 preprint
+Lubin

docs/styles/Vocab/JuMP-Vocab/accept.txt …yles/config/vocabularies/JuMP/accept.txtdocs/styles/Vocab/JuMP-Vocab/accept.txt renamed to docs/styles/config/vocabularies/JuMP/accept.txt docs/styles/Vocab/JuMP-Vocab/accept.txt renamed to docs/styles/config/vocabularies/JuMP/accept.txt

@@ -75,8 +75,8 @@ uses a limited set of bridges that are:
   2. generally applicable for all optimizers.
 
 For some optimizers however, it is useful to add additional bridges, such as
-those that are implemented in external packages (e.g., within the solver package
-itself) or only apply in certain circumstances (e.g.,
+those that are implemented in external packages (for example, within the solver package
+itself) or only apply in certain circumstances (for example,
 [`Constraint.SOCtoNonConvexQuadBridge`](@ref)).
 
 Such optimizers should implement the `ListOfNonstandardBridges` attribute to
@@ -108,7 +108,7 @@ end
 
 ### An optimizer defining an internal bridge
 
-Suppose an optimizer can exploit specific structure of a constraint, e.g., it
+Suppose an optimizer can exploit specific structure of a constraint, for example, it
 can exploit the structure of the matrix `A` in the linear system of equations
 `A * x = b`.
 

src/Bridges/Bridges.jl

@@ -11,8 +11,8 @@ An abstract type that simplifies the creation of other bridges.
 
 !!! warning
     `T` must be a `AbstractFloat` type because otherwise `typemin` and `typemax`
-    would either be not implemented (e.g. `BigInt`), or would not give infinite
-    value (e.g. `Int`). For this reason, this bridge is only added to
+    would either be not implemented (for example, `BigInt`), or would not give infinite
+    value (for example, `Int`). For this reason, this bridge is only added to
     [`MOI.Bridges.full_bridge_optimizer`](@ref) when `T` is a subtype of
     `AbstractFloat`.
 """

src/Bridges/Constraint/bridges/ltgt_to_interval.jl

@@ -81,7 +81,7 @@ function bridge_constraint(
                 "Unable to transform a quadratic constraint into a " *
                 "second-order cone constraint because the quadratic " *
                 "constraint is not strongly convex.\n\nConvex constraints " *
-                "that are not strongly convex (i.e., the matrix is positive " *
+                "that are not strongly convex (that is, the matrix is positive " *
                 "semidefinite but not positive definite) are not supported " *
                 "yet.\n\nNote that a quadratic equality constraint is " *
                 "non-convex.",
@@ -347,7 +347,7 @@ end
 #                       = -u * (z^T Q z/2 + a^T z + b)
 # So the dual of the quadratic constraint is `-u`, so that the contribution
 # to the lagrangian function of both the quadratic and RotatedSOC formulation
-# is exactly the same. Q.E.D.
+# is exactly the same.
 function MOI.get(
     model::MOI.ModelLike,
     attr::Union{MOI.ConstraintDual,MOI.ConstraintDualStart},

src/Bridges/Constraint/bridges/quad_to_soc.jl

@@ -175,7 +175,7 @@ end
 """
     keys_of_type(map::Map, C::Type{<:MOI.ConstraintIndex})
 
-Return a list of all the keys of type `C` in `map` in order order in which they
+Return a list of all the keys of type `C` in `map` in order in which they
 were created with `add_key_for_bridge`.
 """
 function keys_of_type(map::Map, C::Type{MOI.ConstraintIndex{F,S}}) where {F,S}

src/Bridges/Constraint/map.jl

@@ -288,7 +288,7 @@ Record that a constraint `vi`-in-`set` is added and throws if a lower or upper b
 is set by this constraint and such bound has already been set for `vi`.
 """
 function MOI.add_constraint(::Map, ::MOI.VariableIndex, ::MOI.AbstractScalarSet)
-    # Nothing to do as this is is not recognized as setting a lower or upper bound
+    # Nothing to do as this is not recognized as setting a lower or upper bound
 end
 
 # We cannot use `SUPPORTED_VARIABLE_SCALAR_SETS` because
@@ -327,7 +327,7 @@ function MOI.delete(
     ::Map,
     ci::MOI.ConstraintIndex{MOI.VariableIndex,<:MOI.AbstractScalarSet},
 )
-    # Nothing to do as this is is not recognized as setting a lower or upper bound
+    # Nothing to do as this is not recognized as setting a lower or upper bound
 end
 
 function MOI.delete(
@@ -581,7 +581,7 @@ function throw_if_cannot_unbridge(map::Map)
     if map.unbridged_function === nothing
         error(
             "Cannot unbridge function because some variables are bridged by",
-            " variable bridges that do not support reverse mapping, e.g.,",
+            " variable bridges that do not support reverse mapping, for example,",
             " `ZerosBridge`.",
         )
     end