Add backticks

Author: abhro

docs/src/interfaces/Init_Solve.md

@@ -37,7 +37,7 @@ is distinctly different from the
 [LinearSolve init interface](https://docs.sciml.ai/LinearSolve/stable/tutorials/caching_interface)
 which is designed for caching efficiency with reusing factorizations.
 
-## __solve and High-Level Handling
+## `__solve` and High-Level Handling
 
 While `init` and `solve` are the common entry point for users, solver packages will
 mostly define dispatches on `SciMLBase.__init` and `SciMLBase.__solve`. The reason is

docs/src/interfaces/Problems.md

@@ -86,7 +86,7 @@ usage, a `AbstractSciMLProblem` might be associated with some solver configurati
 callback or tolerance. Thus, for flexibility the extra keyword arguments to the
 `AbstractSciMLProblem` are carried to the solver.
 
-### problem_type
+### `problem_type`
 
 `AbstractSciMLProblem` types include a non-public API definition of `problem_type` which holds
 a trait type corresponding to the way the `AbstractSciMLProblem` was constructed. For example,

docs/src/interfaces/SciMLFunctions.md

@@ -94,8 +94,8 @@ on setting up time/parameter dependent operators.
 The solver libraries internally use packages such as [FiniteDiff.jl](https://docs.sciml.ai/FiniteDiff/stable/)
 and [SparseDiffTools.jl](https://docs.sciml.ai/SparseDiffTools/stable/) for
 high performance calculation of sparse Jacobians and Hessians, along with matrix-free
-calculations of Jacobian-Vector products (J*v), vector-Jacobian products (v'*J),
-and Hessian-vector products (H*v). The SciML interface gives users the ability
+calculations of Jacobian-Vector products (`J*v`), vector-Jacobian products (`v'*J`),
+and Hessian-vector products (`H*v`). The SciML interface gives users the ability
 to control these connections in order to allow for top notch performance.
 
 The key arguments in the SciMLFunction is the `prototype`, which is an object

src/SciMLBase.jl

@@ -100,7 +100,7 @@ abstract type AbstractOptimizationCache end
 """
 $(TYPEDEF)
 
-Base for types which define nonlinear solve problems (f(u)=0).
+Base for types which define nonlinear solve problems (`f(u)=0`).
 """
 abstract type AbstractNonlinearProblem{uType, isinplace} <: AbstractDEProblem end
 abstract type AbstractIntervalNonlinearProblem{uType, isinplace} <:

src/alg_traits.jl

@@ -142,7 +142,7 @@ requireshessian(opt) = false
     requiresconsjac(opt)
 
 Trait declaration for whether an optimizer
-requires cons_j in `instantiate_function`, that is, does the optimizer require a constant Jacobian.
+requires `cons_j` in `instantiate_function`, that is, does the optimizer require a constant Jacobian.
 
 Defaults to false.
 """

src/retcodes.jl

@@ -49,7 +49,7 @@ EnumX.@enumx ReturnCode begin
 
     ## Properties
 
-      - successful_retcode = false
+      - `successful_retcode` = `false`
     """
     Default
 
@@ -66,7 +66,7 @@ EnumX.@enumx ReturnCode begin
 
     ## Properties
 
-      - successful_retcode = true
+      - `successful_retcode` = `true`
     """
     Success
 
@@ -90,7 +90,7 @@ EnumX.@enumx ReturnCode begin
 
     ## Properties
 
-      - successful_retcode = true
+      - `successful_retcode` = `true`
     """
     Terminated
 
@@ -113,7 +113,7 @@ EnumX.@enumx ReturnCode begin
 
     ## Properties
 
-      - successful_retcode = false
+      - `successful_retcode` = `false`
     """
     DtNaN
 
@@ -145,7 +145,7 @@ EnumX.@enumx ReturnCode begin
 
     ## Properties
 
-      - successful_retcode = false
+      - `successful_retcode` = `false`
     """
     MaxIters
 
@@ -175,7 +175,7 @@ EnumX.@enumx ReturnCode begin
 
     ## Properties
 
-      - successful_retcode = false
+      - `successful_retcode` = `false`
     """
     DtLessThanMin
 
@@ -194,7 +194,7 @@ EnumX.@enumx ReturnCode begin
 
     ## Properties
 
-      - successful_retcode = false
+      - `successful_retcode` = `false`
     """
     Unstable
 
@@ -219,7 +219,7 @@ EnumX.@enumx ReturnCode begin
 
     ## Properties
 
-      - successful_retcode = false
+      - `successful_retcode` = `false`
     """
     InitialFailure
 
@@ -242,7 +242,7 @@ EnumX.@enumx ReturnCode begin
 
     ## Properties
 
-      - successful_retcode = false
+      - `successful_retcode` = `false`
     """
     ConvergenceFailure
 
@@ -260,7 +260,7 @@ EnumX.@enumx ReturnCode begin
 
     ## Properties
 
-      - successful_retcode = false
+      - `successful_retcode` = `false`
     """
     Failure
 
@@ -279,7 +279,7 @@ EnumX.@enumx ReturnCode begin
 
     ## Properties
 
-      - successful_retcode = true
+      - `successful_retcode` = `true`
     """
     ExactSolutionLeft
 
@@ -298,7 +298,7 @@ EnumX.@enumx ReturnCode begin
 
     ## Properties
 
-      - successful_retcode = true
+      - `successful_retcode` = `true`
     """
     ExactSolutionRight
 
@@ -317,7 +317,7 @@ EnumX.@enumx ReturnCode begin
 
     ## Properties
 
-      - successful_retcode = true
+      - `successful_retcode` = `true`
     """
     FloatingPointLimit
 
@@ -328,7 +328,7 @@ EnumX.@enumx ReturnCode begin
 
     ## Properties
 
-      - successful_retcode = false
+      - `successful_retcode` = `false`
     """
     Infeasible
 
@@ -342,7 +342,7 @@ EnumX.@enumx ReturnCode begin
 
     ## Properties
 
-      - successful_retcode = false
+      - `successful_retcode` = `false`
     """
     MaxTime
 
@@ -353,7 +353,7 @@ EnumX.@enumx ReturnCode begin
 
     ## Properties
 
-      - successful_retcode = false
+      - `successful_retcode` = `false`
     """
     InternalLineSearchFailed
 
@@ -364,7 +364,7 @@ EnumX.@enumx ReturnCode begin
 
     ## Properties
 
-      - successful_retcode = false
+      - `successful_retcode` = `false`
     """
     ShrinkThresholdExceeded
 
@@ -377,7 +377,7 @@ EnumX.@enumx ReturnCode begin
 
     ## Properties
 
-      - successful_retcode = false
+      - `successful_retcode` = `false`
     """
     Stalled
 
@@ -394,7 +394,7 @@ EnumX.@enumx ReturnCode begin
 
     ## Properties
 
-      - successful_retcode = false
+      - `successful_retcode` = `false`
     """
     InternalLinearSolveFailed
 end