add doc (#41)

Author: findmyway

src/environments/classic_control/cartpole.jl

@@ -35,6 +35,19 @@ end
 Base.show(io::IO, env::CartPoleEnv{T}) where {T} =
     print(io, "CartPoleEnv{$T}($(env.params))")
 
+"""
+    CartPoleEnv(;kwargs...)
+
+# Keyword arguments
+- `T = Float64`
+- `gravity = T(9.8)`
+- `masscart = T(1.0)`
+- `masspole = T(0.1)`
+- `halflength = T(0.5)`
+- `forcemag = T(10.0)`
+- `max_steps = 200`
+- `seed = nothing`
+"""
 function CartPoleEnv(;
     T = Float64,
     gravity = T(9.8),

src/environments/classic_control/mountain_car.jl

@@ -47,6 +47,23 @@ mutable struct MountainCarEnv{A,T,R<:AbstractRNG} <: AbstractEnv
     rng::R
 end
 
+"""
+    MountainCarEnv(;kwargs...)
+
+# Keyword arguments
+
+- `T = Float64`
+- `continuous = false`
+- `seed = nothing`
+- `min_pos = -1.2`
+- `max_pos = 0.6`
+- `max_speed = 0.07`
+- `goal_pos = 0.5`
+- `max_steps = 200`
+- `goal_velocity = 0.0`
+- `power = 0.001`
+- `gravity = 0.0025`
+"""
 function MountainCarEnv(; T = Float64, continuous = false, seed = nothing, kwargs...)
     if continuous
         params = MountainCarEnvParams(; goal_pos = 0.45, power = 0.0015, T = T, kwargs...)

src/environments/classic_control/pendulum.jl

@@ -23,6 +23,21 @@ mutable struct PendulumEnv{T,R<:AbstractRNG} <: AbstractEnv
     reward::T
 end
 
+"""
+    PwendulumEnv(;kwargs...)
+
+# Keyword arguments
+
+- `T = Float64`
+- `max_speed = T(8)`
+- `max_torque = T(2)`
+- `g = T(10)`
+- `m = T(1)`
+- `l = T(1)`
+- `dt = T(0.05)`
+- `max_steps = 200`
+- `seed = nothing`
+"""
 function PendulumEnv(;
     T = Float64,
     max_speed = T(8),

src/environments/non_interactive/pendulum.jl

@@ -34,6 +34,19 @@ mutable struct PendulumNonInteractiveEnv{
     rng::R
 end
 
+"""
+    PendulumNonInteractiveEnv(;kwargs...)
+
+# Keyword arguments
+
+- `float_type = Float64`
+- `gravity = 9.8`
+- `length = 2.0`
+- `mass = 1.0`
+- `step_size = 0.01`
+- `maximum_time = 10.0`
+- `seed = nothing`
+"""
 function PendulumNonInteractiveEnv(;
     float_type = Float64,
     gravity = 9.8,