Indent type/method headers in docstrings

Author: abhro

src/alg_traits.jl

@@ -1,5 +1,5 @@
 """
-isautodifferentiable(alg::AbstractDEAlgorithm)
+    isautodifferentiable(alg::AbstractDEAlgorithm)
 
 Trait declaration for whether an algorithm is compatible with
 direct automatic differentiation, i.e. can have algorithms like
@@ -11,7 +11,7 @@ Defaults to false as only pure-Julia algorithms can have this be true.
 isautodifferentiable(alg::AbstractSciMLAlgorithm) = false
 
 """
-forwarddiffs_model(alg::AbstractDEAlgorithm)
+    forwarddiffs_model(alg::AbstractDEAlgorithm)
 
 Trait declaration for whether an algorithm uses ForwardDiff.jl
 on the model function is called with ForwardDiff.jl
@@ -21,7 +21,7 @@ Defaults to false as only pure-Julia algorithms can have this be true.
 forwarddiffs_model(alg::AbstractSciMLAlgorithm) = false
 
 """
-forwarddiffs_model_time(alg::AbstractDEAlgorithm)
+    forwarddiffs_model_time(alg::AbstractDEAlgorithm)
 
 Trait declaration for whether an algorithm uses ForwardDiff.jl
 on the model `f(u,p,t)` function is called with ForwardDiff.jl on the `t` argument.
@@ -32,7 +32,7 @@ have this as true
 forwarddiffs_model_time(alg::AbstractSciMLAlgorithm) = false
 
 """
-allows_arbitrary_number_types(alg::AbstractDEAlgorithm)
+    allows_arbitrary_number_types(alg::AbstractDEAlgorithm)
 
 Trait declaration for whether an algorithm is compatible with
 direct automatic differentiation, i.e. can have algorithms like
@@ -44,7 +44,7 @@ Defaults to false as only pure-Julia algorithms can have this be true.
 allows_arbitrary_number_types(alg::AbstractSciMLAlgorithm) = false
 
 """
-allowscomplex(alg::AbstractDEAlgorithm)
+    allowscomplex(alg::AbstractDEAlgorithm)
 
 Trait declaration for whether an algorithm is compatible with
 having complex numbers as the state variables.
@@ -54,7 +54,7 @@ Defaults to false.
 allowscomplex(alg::AbstractSciMLAlgorithm) = false
 
 """
-isadaptive(alg::AbstractDEAlgorithm)
+    isadaptive(alg::AbstractDEAlgorithm)
 
 Trait declaration for whether an algorithm uses adaptivity,
 i.e. has a non-quasi-static compute graph.
@@ -65,7 +65,7 @@ isadaptive(alg::AbstractDEAlgorithm) = true
 # Default to assuming adaptive, safer error("Adaptivity algorithm trait not set.")
 
 """
-isdiscrete(alg::AbstractDEAlgorithm)
+    isdiscrete(alg::AbstractDEAlgorithm)
 
 Trait declaration for whether an algorithm allows for
 discrete state values, such as integers.
@@ -75,7 +75,7 @@ Defaults to false.
 isdiscrete(alg::AbstractDEAlgorithm) = false
 
 """
-allowsbounds(opt)
+    allowsbounds(opt)
 
 Trait declaration for whether an optimizer allows for
 box constraints passed with `lb` and `ub` in
@@ -86,7 +86,7 @@ Defaults to false.
 allowsbounds(opt) = false
 
 """
-requiresbounds(opt)
+    requiresbounds(opt)
 
 Trait declaration for whether an optimizer requires
 box constraints passed with `lb` and `ub` in
@@ -97,7 +97,7 @@ Defaults to false.
 requiresbounds(opt) = false
 
 """
-allowsconstraints(opt)
+    allowsconstraints(opt)
 
 Trait declaration for whether an optimizer allows
 non-linear constraints specified in `cons` in
@@ -108,7 +108,7 @@ Defaults to false.
 allowsconstraints(opt) = false
 
 """
-requiresconstraints(opt)
+    requiresconstraints(opt)
 
 Trait declaration for whether an optimizer
 requires non-linear constraints specified in
@@ -119,7 +119,7 @@ Defaults to false.
 requiresconstraints(opt) = false
 
 """
-requiresgradient(opt)
+    requiresgradient(opt)
 
 Trait declaration for whether an optimizer
 requires gradient in `instantiate_function`.
@@ -129,7 +129,7 @@ Defaults to false.
 requiresgradient(opt) = false
 
 """
-requireshessian(opt)
+    requireshessian(opt)
 
 Trait declaration for whether an optimizer
 requires hessian in `instantiate_function`.
@@ -139,7 +139,7 @@ Defaults to false.
 requireshessian(opt) = false
 
 """
-requiresconsjac(opt)
+    requiresconsjac(opt)
 
 Trait declaration for whether an optimizer
 requires cons_j in `instantiate_function`, that is, does the optimizer require a constant Jacobian.
@@ -149,7 +149,7 @@ Defaults to false.
 requiresconsjac(opt) = false
 
 """
-requiresconshess(opt)
+    requiresconshess(opt)
 
 Trait declaration for whether an optimizer
 requires cons_h in `instantiate_function`, that is, does the optimizer require a constant hessian.
@@ -159,7 +159,7 @@ Defaults to false.
 requiresconshess(opt) = false
 
 """
-allowscallback(opt)
+    allowscallback(opt)
 
 Trait declaration for whether an optimizer
 supports passing a `callback` to `solve`
@@ -170,7 +170,7 @@ Defaults to true.
 allowscallback(opt) = true
 
 """
-alg_order(alg)
+    alg_order(alg)
 
 The theoretic convergence order of the algorithm. If the method is adaptive order, this is treated
 as the maximum order of the algorithm.

src/integrator_interface.jl

@@ -283,7 +283,7 @@ function reinit!(integrator::DEIntegrator, args...; kwargs...)
 end
 
 """
-initialize_dae!(integrator::DEIntegrator,initializealg = integrator.initializealg)
+    initialize_dae!(integrator::DEIntegrator,initializealg = integrator.initializealg)
 
 Runs the DAE initialization to find a consistent state vector. The optional
 argument `initializealg` can be used to specify a different initialization

src/operators/diffeq_operator.jl

@@ -1,5 +1,5 @@
 """
-AffineDiffEqOperator{T} <: AbstractDiffEqOperator{T}
+    AffineDiffEqOperator{T} <: AbstractDiffEqOperator{T}
 
 `Ex: (A₁(t) + ... + Aₙ(t))*u + B₁(t) + ... + Bₘ(t)`
 

src/retcodes.jl

@@ -1,5 +1,5 @@
 """
-`SciML.ReturnCode`
+    SciML.ReturnCode
 
 `SciML.ReturnCode` is the standard return code enum interface for the SciML interface.
 Return codes are notes given by the solvers to indicate the state of the solution, for
@@ -31,7 +31,7 @@ did not error.
 """
 EnumX.@enumx ReturnCode begin
     """
-    `ReturnCode.Default`
+        ReturnCode.Default
 
     The default state of the solver. If this return code is given, then the solving
     process is either still in process or the solver library has not been setup
@@ -54,7 +54,7 @@ EnumX.@enumx ReturnCode begin
     Default
 
     """
-    `ReturnCode.Success`
+        ReturnCode.Success
 
     The success state of the solver. If this return code is given, then the solving
     process was successful, but no extra information about that success is given.
@@ -71,7 +71,7 @@ EnumX.@enumx ReturnCode begin
     Success
 
     """
-    `ReturnCode.Terminated`
+        ReturnCode.Terminated
 
     The successful termination state of the solver. If this return code is given,
     then the solving process was successful at terminating the solve, usually
@@ -95,7 +95,7 @@ EnumX.@enumx ReturnCode begin
     Terminated
 
     """
-    `ReturnCode.DtNaN`
+        ReturnCode.DtNaN
 
     A failure exit state of the solver. If this return code is given, then the
     solving process was unsuccessful and exited early because the `dt` of the
@@ -118,7 +118,7 @@ EnumX.@enumx ReturnCode begin
     DtNaN
 
     """
-    `ReturnCode.MaxIters`
+        ReturnCode.MaxIters
 
     A failure exit state of the solver. If this return code is given, then the
     solving process was unsuccessful and exited early because the solver's
@@ -150,7 +150,7 @@ EnumX.@enumx ReturnCode begin
     MaxIters
 
     """
-    `ReturnCode.DtLessThanMin`
+        ReturnCode.DtLessThanMin
 
     A failure exit state of the solver. If this return code is given, then the
     solving process was unsuccessful and exited early because the `dt` of the
@@ -180,7 +180,7 @@ EnumX.@enumx ReturnCode begin
     DtLessThanMin
 
     """
-    `ReturnCode.Unstable`
+        ReturnCode.Unstable
 
     A failure exit state of the solver. If this return code is given, then the
     solving process was unsuccessful and exited early because the `unstable_check`
@@ -199,7 +199,7 @@ EnumX.@enumx ReturnCode begin
     Unstable
 
     """
-    `ReturnCode.InitialFailure`
+        ReturnCode.InitialFailure
 
     A failure exit state of the solver. If this return code is given, then the
     solving process was unsuccessful because the initialization process failed.
@@ -224,7 +224,7 @@ EnumX.@enumx ReturnCode begin
     InitialFailure
 
     """
-    `ReturnCode.ConvergenceFailure`
+        ReturnCode.ConvergenceFailure
 
     A failure exit state of the solver. If this return code is given, then the
     solving process was unsuccessful because internal nonlinear solver iterations
@@ -247,7 +247,7 @@ EnumX.@enumx ReturnCode begin
     ConvergenceFailure
 
     """
-    `ReturnCode.Failure`
+        ReturnCode.Failure
 
     A failure exit state of the solver. If this return code is given, then the
     solving process was unsuccessful but no extra information is given.
@@ -265,7 +265,7 @@ EnumX.@enumx ReturnCode begin
     Failure
 
     """
-    `ReturnCode.ExactSolutionLeft`
+        ReturnCode.ExactSolutionLeft
 
     The success state of the solver. If this return code is given, then the solving
     process was successful, and the left solution was given.
@@ -284,7 +284,7 @@ EnumX.@enumx ReturnCode begin
     ExactSolutionLeft
 
     """
-    `ReturnCode.ExactSolutionRight`
+        ReturnCode.ExactSolutionRight
 
     The success state of the solver. If this return code is given, then the solving
     process was successful, and the right solution was given.
@@ -303,7 +303,7 @@ EnumX.@enumx ReturnCode begin
     ExactSolutionRight
 
     """
-    `ReturnCode.FloatingPointLimit`
+        ReturnCode.FloatingPointLimit
 
     The success state of the solver. If this return code is given, then the solving
     process was successful, and the closest floating point value to the solution was given.
@@ -322,7 +322,7 @@ EnumX.@enumx ReturnCode begin
     FloatingPointLimit
 
     """
-    `ReturnCode.Infeasible`
+        ReturnCode.Infeasible
 
     The optimization problem was proven to be infeasible by the solver.
 
@@ -333,7 +333,7 @@ EnumX.@enumx ReturnCode begin
     Infeasible
 
     """
-    `ReturnCode.MaxTime`
+        ReturnCode.MaxTime
 
     A failure exit state of the solver. If this return code is given, then the
     solving process was unsuccessful and exited early because the solver's
@@ -347,7 +347,7 @@ EnumX.@enumx ReturnCode begin
     MaxTime
 
     """
-    `ReturnCode.InternalLineSearchFailed`
+        ReturnCode.InternalLineSearchFailed
 
     Internal Line Search used by the algorithm has failed.
 
@@ -358,7 +358,7 @@ EnumX.@enumx ReturnCode begin
     InternalLineSearchFailed
 
     """
-    `ReturnCode.ShrinkThresholdExceeded`
+        ReturnCode.ShrinkThresholdExceeded
 
     The trust region radius was shrunk more times than the provided threshold.
 
@@ -369,7 +369,7 @@ EnumX.@enumx ReturnCode begin
     ShrinkThresholdExceeded
 
     """
-    `ReturnCode.Stalled`
+        ReturnCode.Stalled
 
     The solution has stalled. This is only returned by algorithms for which stalling is a
     failure mode. Certain solvers like Nonlinear Least Squares solvers are considered
@@ -382,7 +382,7 @@ EnumX.@enumx ReturnCode begin
     Stalled
 
     """
-    `ReturnCode.InternalLinearSolveFailed`
+        ReturnCode.InternalLinearSolveFailed
 
     The linear problem inside another problem (for example inside a NonlinearProblem)
     could not be solved.
@@ -477,8 +477,8 @@ function Base.convert(::Type{ReturnCode.T}, bool::Bool)
 end
 
 """
-`successful_retcode(retcode::ReturnCode.T)::Bool`
-`successful_retcode(sol::AbstractSciMLSolution)::Bool`
+    successful_retcode(retcode::ReturnCode.T)::Bool
+    successful_retcode(sol::AbstractSciMLSolution)::Bool
 
 Returns a boolean for whether a return code should be interpreted as a form of success.
 """