Fix docu

ufechner7 · Apr 14, 2024 · 8b28dfb · 8b28dfb
1 parent 6e6a0a1
commit 8b28dfb
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 4 deletions.
diff --git a/docs/src/types.md b/docs/src/types.md
@@ -13,12 +13,13 @@ AbstractKiteModel
 AKM
 ```
 
-## Struct KPS3 and KPS4
+## Struct KPS3 and KPS4 and KPS4_3L
 ```@docs
 KPS3
 KPS4
+KPS4_3L
 ```
 These structs store the state of the one point model and four point model. Only in unit tests
-it is allowed to access the members directly, otherwise use the input
-and output functions.
+it is allowed to access the members directly, otherwise use the input and output functions.
+The model `KPS4_3L` is not yet implemented, it is just a copy of `KPS4`.
 
diff --git a/src/KPS4_3L.jl b/src/KPS4_3L.jl
@@ -50,7 +50,7 @@ const KITE_SPRINGS_3L = 9
 """
     mutable struct KPS4_3L{S, T, P, Q, SP} <: AbstractKiteModel
 
-State of the kite power system, using a 4 point kite model. Parameters:
+State of the kite power system, using a 4 point kite model and three steering lines to the ground. Parameters:
 - S: Scalar type, e.g. SimFloat
   In the documentation mentioned as Any, but when used in this module it is always SimFloat and not Any.
 - T: Vector type, e.g. MVector{3, SimFloat}