update MOBIL and tim2ddriver docstrings

sisl · Jul 2, 2020 · b1fc10f · b1fc10f
1 parent c4beeb0
commit b1fc10f
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 4 deletions.
diff --git a/src/behaviors/MOBIL.jl b/src/behaviors/MOBIL.jl
@@ -2,11 +2,13 @@
     MOBIL
 See Treiber & Kesting, 'Modeling Lane-Changing Decisions with MOBIL'
 
-# Constructor
-	MOBIL(timestep::Float64;mlon::LaneFollowingDriver=IntelligentDriverModel(),safe_decel::Float64=2.0,       politeness::Float64=0.35,advantage_threshold::Float64=0.1)
+# Constructor 
+
+`MOBIL(;kwargs...)`
+The keyword arguments are the fields highlighted below.
 
 # Fields
-- `dir::Int`
+- `dir::Int = DIR_MIDDLE`
 - `mlon::LaneFollowingDriver=IntelligentDriverModel()`
 - `safe_decel::Float64=2.0`
 - `politeness::Float64=0.35`

diff --git a/src/behaviors/tim_2d_driver.jl b/src/behaviors/tim_2d_driver.jl
@@ -3,7 +3,9 @@
 Driver that combines longitudinal driver and lateral driver into one model.
 
 # Constructors
-	Tim2DDriver(timestep::Float64;mlon::LaneFollowingDriver=IntelligentDriverModel(), mlat::LateralDriverModel=ProportionalLaneTracker(), mlane::LaneChangeModel=TimLaneChanger(timestep))
+
+`Tim2DDriver(;kwargs...)`
+The keywords argument are the fields described below.
 
 # Fields
 - `mlon::LaneFollowingDriver = IntelligentDriverModel()` Longitudinal driving model