Add docstrings

jump-dev · Dec 20, 2023 · a42fc0c · a42fc0c
1 parent 493428d
commit a42fc0c
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/src/Bridges/Variable/map.jl b/src/Bridges/Variable/map.jl
@@ -219,10 +219,20 @@ function number_with_set(map::Map, S::Type{<:MOI.AbstractSet})
     return count(isequal(S), map.sets)
 end
 
+"""
+    first_variable(::Map, ci::MOI.ConstraintIndex{MOI.VariableIndex})
+
+Return the `MOI.VariableIndex` of the `MOI.ConstraintFunction` of `ci`.
+"""
 function first_variable(::Map, ci::MOI.ConstraintIndex{MOI.VariableIndex})
     return MOI.VariableIndex(ci.value)
 end
 
+"""
+    first_variable(::Map, ci::MOI.ConstraintIndex{MOI.VariableIndex})
+
+Return the first `MOI.VariableIndex` of the `MOI.ConstraintFunction` of `ci`.
+"""
 function first_variable(
     map::Map,
     ci::MOI.ConstraintIndex{MOI.VectorOfVariables},