From 11c0228a052ba03698e3260dee6f2a9534574c9b Mon Sep 17 00:00:00 2001
From: u214892 <u214892@sbb.ch>
Date: Thu, 6 Jun 2019 14:41:13 +0200
Subject: [PATCH] 52 code cleanup apidoc first steps

---
 .../{play_model_benchmark.py => complex_rail_benchmark.py}  | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)
 rename benchmarks/{play_model_benchmark.py => complex_rail_benchmark.py} (91%)

diff --git a/benchmarks/play_model_benchmark.py b/benchmarks/complex_rail_benchmark.py
similarity index 91%
rename from benchmarks/play_model_benchmark.py
rename to benchmarks/complex_rail_benchmark.py
index 41c15ef..1f6985d 100644
--- a/benchmarks/play_model_benchmark.py
+++ b/benchmarks/complex_rail_benchmark.py
@@ -1,3 +1,4 @@
+"""Run benchmarks on complex rail flatland."""
 import random
 
 import numpy as np
@@ -7,7 +8,8 @@ from flatland.envs.generators import complex_rail_generator
 from flatland.envs.rail_env import RailEnv
 
 
-def main():
+def run_benchmark():
+    """Run benchmark on a small number of agents in complex rail environment."""
     random.seed(1)
     np.random.seed(1)
 
@@ -66,4 +68,4 @@ if __name__ == "__main__":
     with Benchmarker(cycle=20, extra=1) as bench:
         @bench("Everything")
         def _(bm):
-            main()
+            run_benchmark()
-- 
GitLab