add file level docstrings to all files

This commit is contained in:
Xevion
2020-04-18 01:32:29 -05:00
parent bb4a6cd8e7
commit d24e166e72
3 changed files with 17 additions and 0 deletions

View File

@@ -1,3 +1,9 @@
"""
config.py
Holds all constants used for setting up the game.
May later hold functions for loading/saving configuration files.
"""
class Config(object):
"""
A simple class dedicated to loading, storing and organizing constants.

View File

@@ -1,3 +1,9 @@
"""
main.py
The main class used to load the game.
Holds the main game window, as well as manages basic functions for organizing the game.
"""
import arcade
from config import Config

View File

@@ -1,3 +1,8 @@
"""
mobs.py
Organizes all classes related to Mobs, Entities, Enemies, Players and Items.
"""
import arcade
from config import Config