Issue #5: Added some docstrings for the new classes.

Zarad1993 · Oct 2, 2019 · 1bd27a3 · 1bd27a3
1 parent 95585ab
commit 1bd27a3
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 0 deletions.
diff --git a/dyc/base.py b/dyc/base.py
@@ -1,3 +1,6 @@
+"""
+Base file that contains the core classes that are used in dyc.
+"""
 import fileinput
 from .utils import all_files_generator, get_file_lines
 

diff --git a/dyc/dyc.py b/dyc/dyc.py
@@ -1,3 +1,7 @@
+"""
+This file gets configuration from parser.ParsedConfig
+and handles all the commands from the command line.
+"""
 import click
 from .parser import ParsedConfig
 from .main import DYC

diff --git a/dyc/events.py b/dyc/events.py
@@ -1,3 +1,8 @@
+"""
+This file contains all the event classes used in dyc. It contains
+a Watcher that watches files for changes and a WatchEvent that
+triggers if a file is changed.
+"""
 import sys
 import time
 import logging

diff --git a/dyc/methods.py b/dyc/methods.py
@@ -1,3 +1,8 @@
+"""
+File for classes that handles the actual business logic of
+the application. Here is the the place where the actual reading,
+parsing and validation of the files happens.
+"""
 import sys
 import re
 import fileinput