From d24e166e729f467601fa682d0ee68f0cdc781502 Mon Sep 17 00:00:00 2001 From: Xevion Date: Sat, 18 Apr 2020 01:32:29 -0500 Subject: [PATCH] add file level docstrings to all files --- triple-dungeon/config.py | 6 ++++++ triple-dungeon/main.py | 6 ++++++ triple-dungeon/mobs.py | 5 +++++ 3 files changed, 17 insertions(+) diff --git a/triple-dungeon/config.py b/triple-dungeon/config.py index 052abe1..44bd4ac 100644 --- a/triple-dungeon/config.py +++ b/triple-dungeon/config.py @@ -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. diff --git a/triple-dungeon/main.py b/triple-dungeon/main.py index be1fad2..932d82f 100644 --- a/triple-dungeon/main.py +++ b/triple-dungeon/main.py @@ -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 diff --git a/triple-dungeon/mobs.py b/triple-dungeon/mobs.py index 6856ed1..5242641 100644 --- a/triple-dungeon/mobs.py +++ b/triple-dungeon/mobs.py @@ -1,3 +1,8 @@ +""" +mobs.py +Organizes all classes related to Mobs, Entities, Enemies, Players and Items. +""" + import arcade from config import Config