document pipeline schema constants files

src/easylink/pipeline_schema.py

@@ -22,8 +22,8 @@ class PipelineSchema(HierarchicalStep):
     """All possible pipelines that are fully supported.
 
     A ``PipelineSchema`` is a :class:`~easylink.step.HierarchicalStep` whose
-    :class:`~easylink.graph_components.StepGraph` determines all possible allowable pipelines.
-    The fundamental purpose of this class is to validate that the user-requested
+    :class:`~easylink.graph_components.StepGraph` determines all possible allowable
+    pipelines. The fundamental purpose of this class is to validate that the user-requested
     pipeline to run conforms to a fully supported pipeline.
 
     See :class:`~easylink.step.HierarchicalStep` for inherited attributes.

src/easylink/pipeline_schema_constants/__init__.py

@@ -1,3 +1,14 @@
+"""
+=========================
+Pipeline Schema Constants
+=========================
+
+An EasyLink :class:`~easylink.pipeline_schema.PipelineSchema` is a collection of
+:class:`Steps<easylink.step.Step>` that define a fully supported pipeline. This 
+module defines the nodes and edges required to instantiate such ``PipelineSchemas``.
+
+"""
+
 from easylink.pipeline_schema_constants import development, testing
 
 ALLOWED_SCHEMA_PARAMS = {

src/easylink/pipeline_schema_constants/development.py

@@ -1,7 +1,13 @@
 """
-============================
-Development Pipeline Schemas
-============================
+=====================================
+Development Pipeline Schema Constants
+=====================================
+
+This module contains the parameters required to instantiate the 
+:class:`~easylink.pipeline_schema.PipelineSchema` for the so-called "development" 
+pipeline, i.e. the pipeline used strictly for development purposes as opposed to
+real entity resolution since it relies on dummy steps, data, and containers.
+
 """
 
 from easylink.graph_components import (

src/easylink/pipeline_schema_constants/testing.py

@@ -1,7 +1,11 @@
 """
-=====================
-Test Pipeline Schemas
-=====================
+=================================
+Testing Pipeline Schema Constants
+=================================
+
+This module contains the parameters required to instantiate various 
+:class:`~easylink.pipeline_schema.PipelineSchema` used strictly for testing purposes.
+
 """
 
 from easylink.graph_components import (