Updates and clean ups

Author: TomDonoghue

Makefile

@@ -3,12 +3,16 @@
 ##########################################################################
 ## REQUIREMENTS
 #
-# The following packages are required to run this makefile:
-#   pytest 				For running tests
-#   coverage 			For running test coverage
-#   cloc 				For counting code
-#   pylint 				For running linting on code
-#   setuptools 			For creating distributions
+# This file requires certain dependencies for full functionality.
+#
+# The following Python packages are required:
+#   pytest              For running tests
+#   coverage            For running test coverage
+#   pylint              For running linting on code
+#   setuptools          For creating distributions
+#
+# The following command line utilities are required:
+#   cloc                For counting code
 #
 
 ##########################################################################
@@ -21,58 +25,60 @@ LINT_FILE   = _lint.txt
 ## CODE COUNTING
 
 # Run all counts
-run_counts:
-	@make count_size
-	@make count_cloc
-	@make count_cloc_tests
+run-counts:
+	@make count-size
+	@make count-module
+	@make count-tests
 
 # Count the total number of lines in the module
-count_size:
-	@echo "\n\n CHECK MODULE SIZE:"
+count-size:
+	@printf "\n\nCHECK MODULE SIZE:"
 	@printf "\nNumber of lines of code & comments in the module: "
 	@find ./$(MODULE) -name "*.py" -type f -exec grep . {} \; | wc -l
 
-# Count code with CLOC, excluding test files
-count_cloc:
-	@printf "\n\n CLOC OUTPUT (EXCLUDING TESTS): \n"
+# Count module code with CLOC, excluding test files
+count-module:
+	@printf "\n\nCLOC OUTPUT - MODULE: \n"
 	@cloc $(MODULE) --exclude-dir='tests'
 
 # Count test code, with CLOC
-count_cloc_tests:
-	@printf "\n\n CLOC OUTPUT - TEST FILES: \n"
+count-tests:
+	@printf "\n\nCLOC OUTPUT - TEST FILES: \n"
 	@cloc $(MODULE)/tests --exclude-dir='test_files'
 
 ##########################################################################
 ## CODE TESTING
 
 # Run all tests
-run_tests:
-	make coverage
-	make doctests
+run-tests:
+	@make coverage
+	@make doctests
 
 # Run tests
 tests:
+	@printf "\n\nRUN TESTS: \n"
 	@pytest
 
 # Run test coverage
 coverage:
-	@printf "\n\n RUN TESTS & TEST COVERAGE: \n"
+	@printf "\n\nRUN TESTS: \n"
 	@coverage run --source $(MODULE) -m py.test
+	@printf "\n\nCHECK COVERAGE: \n"
 	@coverage report --omit="*/tests*"
 
 # Run doctests
 doctests:
-	@printf "\n\n CHECK DOCTEST EXAMPLES: \n"
+	@printf "\n\nCHECK DOCTEST EXAMPLES: \n"
 	@pytest --doctest-modules --ignore=$(MODULE)/tests $(MODULE)
 
 ##########################################################################
 ## CODE LINTING
 
 # Run pylint and print summary
-#   Note: --exit-zero is because for some reason pylint
-#     throws an error otherwise. Unclear why.
-run_lints:
-	@printf "\n\n\n RUN PYLINT ACROSS MODULE: \n"
+#   Note: --exit-zero is because pylint throws an error when called
+#     from a Makefile. Unclear why, but this avoids it stopping.
+run-lints:
+	@printf "\n\nRUN PYLINT ACROSS MODULE: \n"
 	@pylint $(MODULE) --ignore tests --exit-zero  > $(LINT_FILE)
 	@tail -n4 $(LINT_FILE)
 
@@ -81,17 +87,17 @@ run_lints:
 
 # Run a summary of the module
 summary:
-	make run_counts
-	make run_tests
-	make run_lints
+	@make run-counts
+	@make run-tests
+	@make run-lints
 
 ##########################################################################
 ## DISTRIBUTION
 
 # Create a distribution build of the module
-distribution:
+dist:
 	@python setup.py sdist bdist_wheel
 
 # Clear out distribution files
-clear_dist:
+clear-dist:
 	@rm -rf build dist $(MODULE).egg-info