formatting fixes

Author: Alexey Stukalov

ext/SEMNLOptExt/NLopt.jl

@@ -20,8 +20,8 @@ SEM.SemOptimizer_impltype(::Val{:NLopt}) = SemOptimizerNLopt
 ############################################################################################
 
 """
-Uses *NLopt.jl* as the optimization engine. For more information on the available algorithms 
-and options, see the [*NLopt.jl*](https://github.com/JuliaOpt/NLopt.jl)  package and the 
+Uses *NLopt.jl* as the optimization engine. For more information on the available algorithms
+and options, see the [*NLopt.jl*](https://github.com/JuliaOpt/NLopt.jl)  package and the
 [NLopt docs](https://nlopt.readthedocs.io/en/latest/).
 
 # Constructor

ext/SEMProximalOptExt/ProximalAlgorithms.jl

@@ -12,20 +12,20 @@ SEM.SemOptimizer{:Proximal}(args...; kwargs...) = SemOptimizerProximal(args...;
 SEM.SemOptimizer_impltype(::Val{:Proximal}) = SemOptimizerProximal
 
 """
-Connects to `ProximalAlgorithms.jl` as the optimization backend. For more information on 
-the available algorithms and options, see the online docs on [Regularization](@ref) and
-the documentation of [*ProximalAlgorithms.jl*](https://github.com/JuliaFirstOrder/ProximalAlgorithms.jl) / [ProximalOperators.jl](https://github.com/JuliaFirstOrder/ProximalOperators.jl).
-
-# Constructor
-
     SemOptimizerProximal(;
         algorithm = ProximalAlgorithms.PANOC(),
         operator_g,
         operator_h = nothing,
         kwargs...,
+    )
+
+Connects to `ProximalAlgorithms.jl` as the optimization backend. For more information on
+the available algorithms and options, see the online docs on [Regularization](@ref) and
+the documentation of [*ProximalAlgorithms.jl*](https://github.com/JuliaFirstOrder/ProximalAlgorithms.jl) /
+[ProximalOperators.jl](https://github.com/JuliaFirstOrder/ProximalOperators.jl).
 
 # Arguments
-- `algorithm`: optimization algorithm.
+- `algorithm`: proximal optimization algorithm.
 - `operator_g`: proximal operator (e.g., regularization penalty)
 - `operator_h`: optional second proximal operator
 """

src/optimizer/abstract.jl

@@ -16,24 +16,24 @@ end
 """
     SemOptimizer(args...; engine::Symbol = :Optim, kwargs...)
 
-Constructs a `SemOptimizer` object that can be passed to [`fit`](@ref) for specifying aspects 
+Constructs a `SemOptimizer` object that can be passed to [`fit`](@ref) for specifying aspects
 of the numerical optimization involved in fitting a SEM.
 
 The keyword `engine` controlls which Julia package is used, with `:Optim` being the default.
 - `optimizer_engines()` prints a list of currently available engines.
 - `optimizer_engine_doc(EngineName)` prints information on the usage of a specific engine.
 
-More engines become available if specific packages are loaded, for example 
-[*NLopt.jl*](https://github.com/JuliaOpt/NLopt.jl) (also see [Constrained optimization](@ref) 
-in the online documentation) or 
+More engines become available if specific packages are loaded, for example
+[*NLopt.jl*](https://github.com/JuliaOpt/NLopt.jl) (also see [Constrained optimization](@ref)
+in the online documentation) or
 [*ProximalAlgorithms.jl*](https://github.com/JuliaFirstOrder/ProximalAlgorithms.jl)
 (also see [Regularization](@ref) in the online documentation).
 
 The additional arguments `args...` and `kwargs...` are engine-specific and control further
 aspects of the optimization process, such as the algorithm, convergence criteria or constraints.
 Information on those can be accessed with `optimizer_engine_doc`.
 
-To connect the SEM package to a completely new optimization backend, you can implement a new 
+To connect the SEM package to a completely new optimization backend, you can implement a new
 subtype of SemOptimizer.
 """
 SemOptimizer(args...; engine::Symbol = :Optim, kwargs...) =
@@ -47,7 +47,7 @@ SemOptimizer{E}(args...; kwargs...) where {E} = SemOptimizer(Val(E), args...; kw
 """
     (1) optimizer_engine(::Type{<:SemOptimizer{E}})
     (2) optimizer_engine(::SemOptimizer{E})
-    
+
 Returns `E`; the engine of a `SemOptimizer` object or a subtype of `SemOptimizer`.
 """
 optimizer_engine(::Type{<:SemOptimizer{E}}) where {E} = E
@@ -62,7 +62,8 @@ the [`SemOptimizer`](@ref) constructor.
 The list of engines depends on the Julia packages loaded (with the `using` directive)
 into the current session.
 """
-optimizer_engines() = Symbol[optimizer_engine(opt_type) for opt_type in subtypes(SemOptimizer)]
+optimizer_engines() =
+    Symbol[optimizer_engine(opt_type) for opt_type in subtypes(SemOptimizer)]
 
 # return the type implementing SemOptimizer{engine}
 # should be overridden in the extension
@@ -85,7 +86,7 @@ optimizer_engine(result::SemOptimizerResult) = optimizer_engine(result.optimizer
 
 """
     fit([optim::SemOptimizer], model::AbstractSem;
-            [engine::Symbol], start_val = start_val, kwargs...)
+        [engine::Symbol], start_val = start_val, kwargs...)
 
 Return the fitted `model`.