11``` @meta
22CurrentModule = MathOptInterface
33DocTestSetup = quote
4- using MathOptInterface
5- const MOI = MathOptInterface
4+ import MathOptInterface as MOI
65end
76DocTestFilters = [r"MathOptInterface|MOI"]
87```
98
109# Naming conventions
1110
12- MOI follows several conventions for naming functions and structures. These
11+ MOI follows several conventions for naming functions and structures. These
1312should also be followed by packages extending MOI.
1413
1514## Sets
1615
17- Sets encode the structure of constraints. Their names should follow the
18- following conventions:
16+ Sets encode the structure of constraints. Their names should follow the
17+ following conventions:
1918
2019* Abstract types in the set hierarchy should begin with ` Abstract ` and end in
2120 ` Set ` , e.g., [ ` AbstractScalarSet ` ] ( @ref ) , [ ` AbstractVectorSet ` ] ( @ref ) .
@@ -26,10 +25,10 @@ following conventions:
2625* Matrix-valued conic sets should provide two representations: ` ConeSquare ` and
2726 ` ConeTriangle ` , e.g., [ ` RootDetConeTriangle ` ] ( @ref ) and
2827 [ ` RootDetConeSquare ` ] ( @ref ) . See [ Matrix cones] ( @ref ) for more details.
29- * Scalar sets should be singular, not plural, e.g., [ ` Integer ` ] ( @ref ) , not
28+ * Scalar sets should be singular, not plural, e.g., [ ` Integer ` ] ( @ref ) , not
3029 ` Integers ` .
31- * As much as possible, the names should follow established conventions in the
32- domain where this set is used: for instance, convex sets should have names
33- close to those of [ CVX] ( http://web.cvxr.com/cvx/doc/ ) , and
34- constraint-programming sets should follow
30+ * As much as possible, the names should follow established conventions in the
31+ domain where this set is used: for instance, convex sets should have names
32+ close to those of [ CVX] ( http://web.cvxr.com/cvx/doc/ ) , and
33+ constraint-programming sets should follow
3534 [ MiniZinc] ( https://www.minizinc.org/doc-latest/en/ ) 's constraints.
0 commit comments