Add short description to all environments

README.adoc

@@ -108,8 +108,7 @@ Run a reinforcement learning process and return the environment helper and the t
 env_helper, rl_dir = run_rl(ENVTYPE)
 ----
 
-`ENVTYPE` has to be replaced by one of the environments named after the file names in the directory `ReCo.jl/RL/Envs`, for example: `LocalCOMEnv`. A description of an environment is included at the beginning of the corresponding file.
-//TODO: Descriptions of envs
+`ENVTYPE` has to be replaced by one of the environments named after the file names in the directory `ReCo.jl/RL/Envs`, for example: `LocalCOMEnv`. A short description of an environment is included at the beginning of the corresponding file.
 
 The documentation of `run_rl` includes all possible optional arguments.
 

src/RL/Envs/COMCompassEnv.jl

@@ -1,3 +1,7 @@
+"""
+This environment corresponds to the center of mass with a compass strategy.
+"""
+
 using ..ReCo: ReCo
 
 struct COMCompassEnv <: Env

src/RL/Envs/LocalCOMEnv.jl

@@ -1,3 +1,7 @@
+"""
+This environment corresponds to the local center of mass strategy.
+"""
+
 using ..ReCo: ReCo
 
 struct LocalCOMEnv <: Env

src/RL/Envs/LocalCOMWithAdditionalShapeRewardEnv.jl

@@ -1,3 +1,8 @@
+"""
+This environment corresponds to the local center of mass strategy with an additional shape reward term.
+The minimization variable of the additional reward term is the individual elliptical distance of a particle.
+"""
+
 using ..ReCo: ReCo
 
 struct LocalCOMWithAdditionalShapeRewardEnv <: Env

src/RL/Envs/LocalCOMWithAdditionalShapeRewardEnv2.jl

@@ -1,3 +1,8 @@
+"""
+This environment corresponds to the local center of mass strategy with an additional shape reward term.
+The minimization variable of the additional reward term is the absolute difference of the current value of κ to the goal value.
+"""
+
 using ..ReCo: ReCo
 
 struct LocalCOMWithAdditionalShapeRewardEnv2 <: Env

src/RL/Envs/NearestNeighborEnv.jl

@@ -1,3 +1,7 @@
+"""
+This environment corresponds to the nearest neighbor strategy.
+"""
+
 using ..ReCo: ReCo
 
 struct NearestNeighborEnv <: Env

src/RL/Envs/OriginCompassEnv.jl

@@ -1,3 +1,7 @@
+"""
+This environment corresponds to the strategy of the origin of the coordinates system with a compass.
+"""
+
 using ..ReCo: ReCo
 
 struct OriginCompassEnv <: Env

src/RL/Envs/OriginEnv.jl

@@ -1,3 +1,7 @@
+"""
+This environment corresponds to the strategy of the origin of the coordinates system.
+"""
+
 using ..ReCo: ReCo
 
 struct OriginEnv <: Env