added more doocstrings and improved the readme

2022-01-04 09:16:17 -07:00
parent d138778f0a
commit c075f3f66a
4 changed files with 33 additions and 1 deletions
--- a/cfg_util/miner_factory.py
+++ b/cfg_util/miner_factory.py
@@ -1,3 +1,7 @@
+"""
+This file stores the MinerFactory instance used by the ConfigUtility for use in other files.
+"""
+
 from miners.miner_factory import MinerFactory

 miner_factory = MinerFactory()