diff --git a/AUTHORS.rst b/AUTHORS.rst index 5c530ddfc7bd0e80b6b205483213120f3188132d..4f9e269769ca898e6e6fcdf47a82b103e2133d2d 100644 --- a/AUTHORS.rst +++ b/AUTHORS.rst @@ -2,7 +2,7 @@ Credits ======= -Development Lead +Development ---------------- * S.P. Mohanty <mohanty@aicrowd.com> diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 0a8ea8f70d51e2122f9b79099e13b0e4fe3fc4c3..e7ad21df59c93552484940c8b29774d9d1fee60e 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -88,7 +88,7 @@ Ready to contribute? Here's how to set up `flatland` for local development. 6. Commit your changes and push your branch to Gitlab:: $ git add . - $ git commit -m "Your detailed description of your changes." + $ git commit -m "Addresses #<issue-number> Your detailed description of your changes." $ git push origin name-of-your-bugfix-or-feature 7. Submit a merge request through the Gitlab repository website. diff --git a/README.rst b/README.rst index 50ff2cf0f3b5871cded5f6ee08291f97e12234a2..cb544ba67d63784fb0cbdd90e4c2aed118b96c74 100644 --- a/README.rst +++ b/README.rst @@ -24,6 +24,7 @@ Generate Docs git clone git@gitlab.aicrowd.com:flatland/flatland.git cd flatland + pip install -r requirements_dev.txt make docs Features diff --git a/flatland/core/env.py b/flatland/core/env.py index fccaaa8375fd2d9b5524e585034c43b1435a3bcb..a07a8095575a18eb20eb57a779fb3585dd01cf75 100644 --- a/flatland/core/env.py +++ b/flatland/core/env.py @@ -54,6 +54,7 @@ class Environment: """ Performs an environment step with simultaneous execution of actions for agents in action_dict. + Returns observations from agents in the environment. The returns are dicts mapping from agent_id strings to values.