v0.4.5

control-toolbox · Jul 27, 2023 · c301be6 · c301be6
1 parent 2ed2514
commit c301be6
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 6 deletions.
diff --git a/Project.toml b/Project.toml
@@ -1,7 +1,7 @@
 name = "CTDirect"
 uuid = "790bbbee-bee9-49ee-8912-a9de031322d5"
 authors = ["Olivier Cots <olivier.cots@enseeiht.fr>"]
-version = "0.4.4"
+version = "0.4.5"
 
 [deps]
 ADNLPModels = "54578032-b7ea-4c30-94aa-7cbd1cce6c9a"

diff --git a/docs/src/api.md b/docs/src/api.md
@@ -13,7 +13,7 @@ Private = false
 
 ```@example
 using CTDirect
-Methods()
+available_methods()
 ```
 
 ## Documentation

diff --git a/src/CTDirect.jl b/src/CTDirect.jl
@@ -24,6 +24,6 @@ include("solve.jl")
 export solve
 export is_solvable
 export OptimalControlInit
-export Methods
+export available_methods
 
 end
diff --git a/src/solve.jl b/src/solve.jl
@@ -7,7 +7,7 @@ $(TYPEDSIGNATURES)
 
 Return the list of available methods to solve the optimal control problem.
 """
-function Methods()::Tuple{Tuple{Vararg{Symbol}}}
+function available_methods()::Tuple{Tuple{Vararg{Symbol}}}
     return algorithmes
 end
 
@@ -43,7 +43,7 @@ Keyword arguments:
 
 !!! tip
 
-    - To see the list of available methods, simply call `Methods()`.
+    - To see the list of available methods, simply call `available_methods()`.
     - You can pass any other option by a pair `keyword=value` according to the chosen method. See for instance, [`Ipopt` options](https://coin-or.github.io/Ipopt/OPTIONS.html).
     - The default values for the keyword arguments are given [here](https://control-toolbox.org/CTDocs.jl/ctbase/stable/api-default.html).
 
@@ -66,7 +66,7 @@ function solve(ocp::OptimalControlModel,
     # get full description from partial
     # throw error if description is not valid
     # thus, no else is needed below
-    method = getFullDescription(description, Methods())
+    method = getFullDescription(description, available_methods())
 
     # Model: from ocp to nlp
     if :adnlp in method