Add a bunch of doc strings and header comments to files

erynrl/map/generator/__init__.py

@@ -12,13 +12,16 @@ class MapGenerator:
 
     @property
     def up_stairs(self) -> List[Point]:
+        '''The location of any routes to a higher floor of the dungeon.'''
         raise NotImplementedError()
 
     @property
     def down_stairs(self) -> List[Point]:
+        '''The location of any routes to a lower floor of the dungeon.'''
         raise NotImplementedError()
 
     def generate(self, tiles: np.ndarray):
+        '''Generate a map and place it in `tiles`'''
         raise NotImplementedError()
 
 

erynrl/map/generator/corridor.py

@@ -1,3 +1,5 @@
+# Eryn Wells <eryn@erynwells.me>
+
 '''
 Defines an abstract CorridorGenerator and several concrete subclasses. These classes generate corridors between rooms.
 '''