Additional file comments

src/lib/subroutines.jl

@@ -1,3 +1,9 @@
+"""
+    subroutines.jl
+
+# Description
+Common low-level functions, such as for operating on matrices and vectors.
+"""
 
 # -----------------------------------------------------------------------------
 # COMMON LOW-LEVEL FUNCTIONS

src/lib/symbols.jl

@@ -1,3 +1,13 @@
+"""
+    symbols.jl
+
+# Description
+Symbols for macro evaluation of activation, match, and learning functions.
+"""
+
+# -----------------------------------------------------------------------------
+# FUNCTIONS
+# -----------------------------------------------------------------------------
 
 """
 Low-level common function for computing the 1-norm of the element minimum of a sample and weights.
@@ -152,6 +162,10 @@ function art_learn(art::ARTModule, x::RealVector, index::Integer)
     return eval(art.opts.update)(art, x, get_sample(art.W, index))
 end
 
+# -----------------------------------------------------------------------------
+# ENUMERATIONS
+# -----------------------------------------------------------------------------
+
 """
 Enumerates all of the update functions available in the package.
 """
@@ -175,4 +189,4 @@ const ACTIVATION_FUNCTIONS = [
     :unnormalized_match,
     :choice_by_difference,
     :gamma_activation,
-]
+]

test/runtests.jl

@@ -1,11 +1,20 @@
 """
     runtests.jl
 
+# Description
 The entry point to unit tests for the AdaptiveResonance.jl package.
 """
 
+# -----------------------------------------------------------------------------
+# DEPENDENCIES
+# -----------------------------------------------------------------------------
+
 using SafeTestsets
 
+# -----------------------------------------------------------------------------
+# SAFETESTSETS
+# -----------------------------------------------------------------------------
+
 @safetestset "All Test Sets" begin
     include("test_sets.jl")
 end