From 02d06d180e3279fcb6fc5810ad55e93d89761d86 Mon Sep 17 00:00:00 2001
From: Ronny Bergmann <git@ronnybergmann.net>
Date: Thu, 26 Sep 2024 21:24:06 +0200
Subject: [PATCH] Fix a few typos on ALM docs. (#413)

* Fix two typos in Manopt.jl

* add new entry to changelog.
---
 Changelog.md                               |  6 ++++++
 src/documentation_glossary.jl              | 10 ++++++++--
 src/solvers/augmented_Lagrangian_method.jl |  4 ++--
 3 files changed, 16 insertions(+), 4 deletions(-)

diff --git a/Changelog.md b/Changelog.md
index 4b544dcfe9..d0066bbe25 100644
--- a/Changelog.md
+++ b/Changelog.md
@@ -5,6 +5,12 @@ All notable Changes to the Julia package `Manopt.jl` will be documented in this
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.5.2] – unreleased
+
+### Changed
+
+* fix a few typos in the docstrings.
+
 ## [0.5.1] – September 4, 2024
 
 ### Changed
diff --git a/src/documentation_glossary.jl b/src/documentation_glossary.jl
index b30b25f268..55b9aa4427 100644
--- a/src/documentation_glossary.jl
+++ b/src/documentation_glossary.jl
@@ -216,6 +216,9 @@ define!(
     end,
 )
 
+#
+#
+# Problems
 define!(
     :Problem,
     :Constrained,
@@ -223,7 +226,7 @@ define!(
     ```math
 \\begin{aligned}
 \\min_{$p ∈ $(_tex(:Cal, M))} & f($p)\\\\
-$(_tex(:text, "subject to")) &g_i($p) ≤ 0 \\quad $(_tex(:text, " for ")) i= 1, …, m,\\\\
+$(_tex(:text, "subject to"))$(_tex(:quad))&g_i($p) ≤ 0 \\quad $(_tex(:text, " for ")) i= 1, …, m,\\\\
 \\quad & h_j($p)=0 \\quad $(_tex(:text, " for ")) j=1,…,n,
 \\end{aligned}
 ```
@@ -299,8 +302,11 @@ define!(
         return "* `$(display)$(type ? "::$(length(t) > 0 ? t : _var(s, :type))" : "")=`$(length(default) > 0 ? default : _var(s, :default; kwargs...))$(description ? ": $(_var(s, :description; kwargs...))" : "")$(disp_add)"
     end,
 )
+
+#
+#
 #
-# Actual variables
+# variables / Names used in Arguments, Fields, and Keywords
 
 define!(
     :Variable,
diff --git a/src/solvers/augmented_Lagrangian_method.jl b/src/solvers/augmented_Lagrangian_method.jl
index 125f973642..d26006f916 100644
--- a/src/solvers/augmented_Lagrangian_method.jl
+++ b/src/solvers/augmented_Lagrangian_method.jl
@@ -231,9 +231,9 @@ This method can work in-place of `p`.
 
 The aim of the ALM is to find the solution of the constrained optimisation task
 
-$_problem(:Constrained)
+$(_problem(:Constrained))
 
-where `M` is a Riemannian manifold, and ``f``, ``$(_math(:Sequence, "g", "i", "1", "n"))`` and ``$(_math(:Sequence, "h", "j", "1", "m"))
+where `M` is a Riemannian manifold, and ``f``, ``$(_math(:Sequence, "g", "i", "1", "n"))`` and ``$(_math(:Sequence, "h", "j", "1", "m"))``
 are twice continuously differentiable functions from `M` to ℝ.
 In every step ``k`` of the algorithm, the [`AugmentedLagrangianCost`](@ref)
  ``$(_doc_AL_Cost("k"))`` is minimized on $(_tex(:Cal, "M")),