Document all classes in the project.

Author: lfagundes

solid_node/cli.py

@@ -9,6 +9,9 @@
 ]
 
 def manage():
+    """
+    Runs cli commands, available in managers.* namespace
+    """
     parser = argparse.ArgumentParser(description='Solid Node')
 
     parser.add_argument(

solid_node/core/broker.py

@@ -18,9 +18,10 @@
 
 
 class BrokerServer:
-
-    # This is not being used, because it does not work for the builder.
-    # But for the assistant it probably will, so it was kept
+    """The broker is a persistent webserver process that
+    implements locking to synchronize other processes and
+    topics to exchange messages.
+    """
     topics = []
 
     keys = [

solid_node/core/builder.py

@@ -17,7 +17,7 @@
 
 
 class Builder(FileSystemEventHandler):
-    """Monitors .py files and generate STLs, and exit on any change"""
+    """Monitors .py files. On any change, generate STLs and exit"""
     def __init__(self, path):
         super().__init__()
         self.path = path

solid_node/core/git.py

@@ -9,6 +9,9 @@
 
 
 class GitRepo:
+    """Manages a git repository for user's project. Every time
+    user saves a file, the repository is commited, and if the
+    build fails, it's rolled back."""
     def __init__(self, file_path):
         self.repo = _find_repo_root(file_path)
         self._lock = None

solid_node/exceptions.py

@@ -1,3 +1,6 @@
+"""This is only being used by node/spatial.py, which is
+not being used. In quarantine too."""
+
 class MeshNotRendered(Exception):
     pass
 

solid_node/manager/develop.py

@@ -25,7 +25,10 @@
 
 
 class Develop:
-    """Monitor filesystem and executes transpilations and compilations on background"""
+    """Runs all processes required for developing with solid-node.
+    Monitors filesystem and executes transpilations and compilations on background,
+    and runs servers to support a web frontend
+    """
 
     def add_arguments(self, parser):
         parser.add_argument('--web', action='store_true',

solid_node/manager/test.py

@@ -8,7 +8,9 @@
 from solid_node.test import TestCase
 
 class Test:
-    """Run a node's tests"""
+    """Nodes may implement tests by inheriting solid_node.test.TestCaseMixin
+    and creating test methods starting with test_.
+    This command runs Run all tests from a node"""
 
     def __init__(self):
         self.num_tests = 0

solid_node/node/assembly.py

@@ -5,9 +5,7 @@
 class AssemblyNode(InternalNode):
     """
     Represents a collection of components that can be moved relative to each other.
-
     This is an internal node that can contain instances of LeafNode or other internal nodes.
-
     The render method of this class returns a list of its child nodes.
     """
 

solid_node/node/base.py

@@ -24,6 +24,11 @@ def _build_uniq_id(args, kwargs):
     return ','.join(str(a) for a in all_args)
 
 class AbstractBaseNode:
+    """A mechanical project in solid-node is represented by a
+    tree, and this is the abstract base class for all nodes.
+    Above this class, there are two other base classes:
+    LeafNode and InternalNode.
+    """
 
     fn = None
 

solid_node/node/fusion.py

@@ -4,9 +4,7 @@
 class FusionNode(InternalNode):
     """
     Represents a fusion of components into a single, inseparable unit.
-
     This is an internal node that can contain instances of LeafNode or other internal nodes.
-
     The render method of this class returns a list of its child nodes.
     """