Merge pull request #98 from JamieMair/improve-wrapped-function-docs

Improved docs for wrapped functions
JamieMair · Dec 6, 2023 · 187bbc4 · 187bbc4
2 parents 9ddd3e2 + 554e0d2
commit 187bbc4
Show file tree

Hide file tree

Showing 2 changed files with 262 additions and 262 deletions.
diff --git a/gen/parsing/function_constraints.jl b/gen/parsing/function_constraints.jl
@@ -394,27 +394,27 @@ end
 
 function argument_doc_description(arg_info)
     if arg_info.type == :basic
-        return "- $(arg_info.identifier)::$(arg_info.datatype)"
+        return "- **`$(arg_info.identifier)::$(arg_info.datatype)`**"
     elseif arg_info.type == :string
-        return "- $(arg_info.identifier)::String" * (arg_info.is_const ? " -> Constant." : "")
+        return "- **`$(arg_info.identifier)::String`**" * (arg_info.is_const ? " -> Constant." : "")
     elseif arg_info.type == :mjModel
-        return "- $(arg_info.identifier)::Model" * (arg_info.is_const ? " -> Constant." : "")
+        return "- **`$(arg_info.identifier)::Model`**" * (arg_info.is_const ? " -> Constant." : "")
     elseif arg_info.type == :mjData
-        return "- $(arg_info.identifier)::Data" * (arg_info.is_const ? " -> Constant." : "")
+        return "- **`$(arg_info.identifier)::Data`**" * (arg_info.is_const ? " -> Constant." : "")
     elseif arg_info.type == :anomalous_vector
         opt = arg_info.is_optional ? "An optional" : "A"
         if arg_info.is_dynamic_size
-            return "- $(arg_info.identifier)::Vector{$(arg_info.datatype)} -> $opt vector of variable size. Check additional info for sizes." * (arg_info.is_inner_const ? " Constant." : "")
+            return "- **`$(arg_info.identifier)::Vector{$(arg_info.datatype)}`** -> $opt vector of variable size. Check additional info for sizes." * (arg_info.is_inner_const ? " Constant." : "")
         else
-            return "- $(arg_info.identifier)::Vector{$(arg_info.datatype)} -> $opt vector of size $(arg_info.size_vector)." * (arg_info.is_inner_const ? " Constant." : "")
+            return "- **`$(arg_info.identifier)::Vector{$(arg_info.datatype)}`** -> $opt vector of size $(arg_info.size_vector)." * (arg_info.is_inner_const ? " Constant." : "")
         end
     elseif arg_info.type == :variable_vector
         opt = arg_info.is_optional ? "An optional" : "A"
-        return "- $(arg_info.identifier)::Vector{$(arg_info.datatype)} -> $opt vector of variable size. Check additional info for sizes." * (arg_info.is_inner_const ? " Constant." : "")
+        return "- **`$(arg_info.identifier)::Vector{$(arg_info.datatype)}`** -> $opt vector of variable size. Check additional info for sizes." * (arg_info.is_inner_const ? " Constant." : "")
     elseif arg_info.type == :static_array
-        return "- $(arg_info.identifier)::Vector{$(arg_info.datatype)} -> A vector of size $(arg_info.array_size)." * (arg_info.is_const ? " Constant." : "")
+        return "- **`$(arg_info.identifier)::Vector{$(arg_info.datatype)}`** -> A vector of size $(arg_info.array_size)." * (arg_info.is_const ? " Constant." : "")
     elseif arg_info.type == :matrix
-        return "- $(arg_info.identifier)::Matrix{$(arg_info.datatype)} -> A matrix variable size. Check additional info for sizes." * (arg_info.is_inner_const ? " Constant." : "")
+        return "- **`$(arg_info.identifier)::Matrix{$(arg_info.datatype)}`** -> A matrix variable size. Check additional info for sizes." * (arg_info.is_inner_const ? " Constant." : "")
     else
         error("Unrecognised argument info for variable $(arg_info)")
     end