From 6edf8dfc88553b7caa75deb30e44da2f1f8f7368 Mon Sep 17 00:00:00 2001 From: Daniel Fremont Date: Thu, 22 Oct 2020 07:36:10 -0700 Subject: [PATCH] added note about SDL error; minor docs fix --- docs/quickstart.rst | 6 ++++++ src/scenic/domains/driving/behaviors.scenic | 8 +++++--- 2 files changed, 11 insertions(+), 3 deletions(-) diff --git a/docs/quickstart.rst b/docs/quickstart.rst index bfe4389b3..8a6a46e0a 100644 --- a/docs/quickstart.rst +++ b/docs/quickstart.rst @@ -43,6 +43,12 @@ Installing via either :command:`pip` or Poetry will install all of the dependenc In the past, the ``shapely`` package did not install properly on Windows. If you encounter this issue, try installing it manually following the instructions `here `__. +.. note:: + + On some platforms, in particular OS X, you may get an error during the installation of `pygame `_ due to missing SDL files. + Try installing `SDL `_: on OS X, if you use `Homebrew `_ you can simply run :command:`brew install sdl`. + + Trying Some Examples -------------------- diff --git a/src/scenic/domains/driving/behaviors.scenic b/src/scenic/domains/driving/behaviors.scenic index 81be27d12..21d2b2045 100644 --- a/src/scenic/domains/driving/behaviors.scenic +++ b/src/scenic/domains/driving/behaviors.scenic @@ -61,9 +61,11 @@ behavior FollowLaneBehavior(target_speed = 10, laneToFollow=None, is_oppositeTra This behavior does not terminate. A recommended use of the behavior is to accompany it with condition, e.g. do FollowLaneBehavior() until ... - :param target_speed: Its unit is in m/s. By default, it is set to 10 m/s - :param laneToFollow: If the lane to follow is different from the lane that the vehicle is on, this parameter can be used to specify that lane. - By default, this variable will be set to None, which means that the vehicle will follow the lane that it is currently on. + Arguments: + target_speed: Its unit is in m/s. By default, it is set to 10 m/s + laneToFollow: If the lane to follow is different from the lane that the vehicle is on, + this parameter can be used to specify that lane. By default, this variable will be + set to None, which means that the vehicle will follow the lane that it is currently on. """ past_steer_angle = 0