Skip to content

[docs] modify the TokenIgnores in vale for fewer false negatives #2114

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 3, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions docs/.vale.ini
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,4 @@ Vocab = JuMP-Vocab
[*.md]
BasedOnStyles = Vale, Google

# Skip \\token and \token LaTeX commands
TokenIgnores = \\\\[a-z]+, \\[a-z]+, [a-zA-Z]+_[_a-zA-Z]+
TokenIgnores = \$.+?\$, \]\(@(ref|id).+?\)
2 changes: 1 addition & 1 deletion docs/src/background/duality.md
Original file line number Diff line number Diff line change
Expand Up @@ -214,7 +214,7 @@ However, the dual of [`PositiveSemidefiniteConeSquare`](@ref) is not so straight
forward. This section explains the duality convention we use, and how it is
derived.

!!! info "tl;dr"
!!! info
If you have a [`PositiveSemidefiniteConeSquare`](@ref) constraint, the
result matrix ``A`` from [`ConstraintDual`](@ref) is not positive
semidefinite. However, ``A + A^\top`` is positive semidefinite.
Expand Down
11 changes: 6 additions & 5 deletions docs/src/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -563,7 +563,7 @@ for advice on updating a specific deprecated feature.
- Added `Utilities.set_with_dimension`
- Added two-argument `optimize!(::AbstractOptimizer, ::ModelLike)`
- The experimental feature `copy_to_and_optimize!` has been removed
- Det bridges now support getting `ConstraintFunction` and `ConstraintSet`
- `Det` bridges now support getting `ConstraintFunction` and `ConstraintSet`
- Various minor bug fixes identified by improved testing

## v0.10.1 (September 8, 2021)
Expand Down Expand Up @@ -757,7 +757,8 @@ This release contains backports from the ongoing development of the v0.10 releas
## v0.9.18 (November 3, 2020)

- Various improvements for working with complex numbers
- Added `GeoMeantoRelEntrBridge` to bridge a geomean constraint to a relative entropy constraint
- Added `GeoMeantoRelEntrBridge` to bridge a `GeometricMeanCone` constraint to a
relative entropy constraint

## v0.9.17 (September 21, 2020)

Expand Down Expand Up @@ -891,7 +892,7 @@ This release contains backports from the ongoing development of the v0.10 releas
* Added support for starting values for `Variable.VectorizeBridge` (#944).
* Fixed `MOI.add_constraints` with non-bridged variable constraint on bridged
variable (#951).
* Fixed corner cases and docstring of geomean bridge (#961, #962, #966).
* Fixed corner cases and docstring of `GeoMeanBridge` (#961, #962, #966).
* Fixed choice between variable or constraint bridges for constrained
variables (#973).
* Improve performance of bridge shortest path (#945, #946, #956).
Expand Down Expand Up @@ -920,7 +921,7 @@ This release contains backports from the ongoing development of the v0.10 releas
* Added `InvalidIndex` tests in `basic_constraint_tests` (#921).
* Added tests for the constant term in indicator constraint (#929).
- Bridges improvements:
* Added support for starting values for functionize bridges (#923).
* Added support for starting values for `Functionize` bridges (#923).
* Added variable indices context to variable bridges (#920).
* Fixed a typo in printing o `debug_supports` (#927).

Expand Down Expand Up @@ -1067,7 +1068,7 @@ This release contains backports from the ongoing development of the v0.10 releas
- Performance improvement in `default_copy_to` and bridge optimizer (#696).
- Add `Silent` and implement setting optimizer attributes in caching and mock
optimizers (#695).
- Add functionize bridges (SingleVariable and VectorOfVariables) (#659).
- Add `Functionize` bridges (SingleVariable and VectorOfVariables) (#659).
- Minor typo fixes (#694).

## v0.8.3 (March 6, 2019)
Expand Down
4 changes: 2 additions & 2 deletions docs/src/manual/constraints.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,8 +92,8 @@ Below is a list of common constraint types and how they are represented
as function-set pairs in MOI. In the notation below, ``x`` is a vector of
decision variables, ``x_i`` is a scalar decision variable, ``\alpha, \beta`` are
scalar constants, ``a, b`` are constant vectors, `A` is a constant matrix and
``\mathbb{R}_+`` (resp. ``\mathbb{R}_-``) is the set of nonnegative (resp.
nonpositive) real numbers.
``\mathbb{R}_+`` (resp. ``\mathbb{R}_-``) is the set of non-negative (resp.
non-positive) real numbers.

### Linear constraints

Expand Down
6 changes: 3 additions & 3 deletions docs/src/tutorials/mathprogbase.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ as a modeling interface instead.
If you haven't used JuMP before, start with the tutorial
[Getting started with JuMP](https://jump.dev/JuMP.jl/stable/tutorials/getting_started/getting_started_with_JuMP/)

### linprog
### `linprog`

Here is one way of transitioning from `linprog`:

Expand All @@ -47,7 +47,7 @@ function linprog(c, A, sense, b, l, u, solver)
end
```

### mixintprog
### `mixintprog`

Here is one way of transitioning from `mixintprog`:

Expand Down Expand Up @@ -76,7 +76,7 @@ function mixintprog(c, A, rowlb, rowub, vartypes, lb, ub, solver)
end
```

### quadprog
### `quadprog`

Here is one way of transitioning from `quadprog`:

Expand Down
14 changes: 2 additions & 12 deletions docs/styles/Vocab/JuMP-Vocab/accept.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@ arXiv
backports
blogposts
bugfixe(?s)
const
expr
datastructure
docstring(?s)
doctest
Expand All @@ -15,24 +13,16 @@ flamegraph
getters
[Jj]ulia
[Pp]recompil(ation|(e(?d)))
src
subexpression(?s)

% JuMP-related vocab
[Cc]anonicaliz(e|ation|ing)
[Dd]et
functionize
geomean
(lin|mixint|quad)prog
(log|root)det
(L|Q)Ps
multiobjective
nonconvex
[Nn]on(posi|nega)tive(?s)
parameterizing
[Pp]resolve
[Ss]emi(continuous|integer|definite)
tl
Presolve
[Ss]emidefinite
unboundedness
[Un]nivariate

Expand Down