fix docstring

Author: zsteve

docs/src/index.md

@@ -23,7 +23,7 @@ sinkhorn_unbalanced
 sinkhorn_unbalanced2
 ```
 
-## Quadratically regularised optimal transport
+## Optimal transport with general regularisation 
 ```@docs
-quadreg
+ot_reg_plan
 ```

examples/basic/script.jl

@@ -94,7 +94,7 @@ sinkhorn2(μ, ν, C, ε)
 # resulting transport plan $\gamma$ is *sparse*. We take advantage of this and represent it as
 # a sparse matrix. 
 
-quadreg(μ, ν, C, ε; maxiter=500);
+ot_reg_plan(μ, ν, C, ε; reg_func = "L2", method = "lorenz", maxiter=500);
 
 # ## Stabilized Sinkhorn algorithm
 #
@@ -190,7 +190,7 @@ heatmap(
 # Notice how the "edges" of the transport plan are sharper if we use quadratic regularisation
 # instead of entropic regularisation:
 
-γquad = Matrix(quadreg(μ, ν, C, 5; maxiter=500))
+γquad = Matrix(ot_reg_plan(μ, ν, C, 5; reg_func = "L2", method = "lorenz", maxiter=500))
 heatmap(
     μsupport,
     νsupport,

src/OptimalTransport.jl

@@ -517,7 +517,7 @@ general choice of regulariser `math Ω(γ)`. Solves for `gamma` that minimises
 ```
 
 Supported choices of `math Ω` are:
-- L2: `math Ω(γ) = \\frac{1}{2} \\| γ \\|_2^2`, `reg_func = "L2"`
+- L2: ``Ω(γ) = \\frac{1}{2} \\| γ \\|_2^2``, `reg_func = "L2"`
 
 Supported solution methods are:
 - L2: `method = "lorenz"` for the semi-smooth Newton method of Lorenz et al.