some documentation. add register process decorator

process_bigraph/__init__.py

@@ -1,6 +1,6 @@
 import pprint
 from process_bigraph.protocols import local_lookup
-from process_bigraph.registry import protocol_registry, process_registry
+from process_bigraph.registry import protocol_registry, process_registry,register_process
 from process_bigraph.emitter import ConsoleEmitter, RAMEmitter, DatabaseEmitter
 from process_bigraph.composite import Process, Step, Composite
 from process_bigraph.type_system import types

process_bigraph/registry.py

@@ -25,3 +25,19 @@
 #: Maps process names to :term:`protocol methods`
 protocol_registry = Registry()
 
+# decorator to register processes
+def register_process(name):
+    """Register a process with the process registry.
+    
+    :param name: The name of the process.
+    
+    :Example:
+        @register_process('my_process')
+        class MyProcess(Process):
+            ...
+    """
+    def decorator(func):
+        process_registry.register(name, func)
+        return func
+
+    return decorator

process_bigraph/type_system.py

@@ -35,6 +35,7 @@ def divide_process(value, bindings=None, types=None):
 
 
 def serialize_process(value, bindings=None, types=None):
+    """Serialize a process to a JSON-safe representation."""
     # TODO -- need to get back the protocol: address and the config
     process = value.copy()
     del process['instance']
@@ -49,6 +50,16 @@ def serialize_process(value, bindings=None, types=None):
 
 
 def deserialize_process(serialized, bindings=None, types=None):
+    """Deserialize a process from a serialized state.
+
+    This function is used by the type system to deserialize a process.
+
+    :param serialized: A JSON-safe representation of the process.
+    :param bindings: The bindings to use for deserialization.
+    :param types: The type system to use for deserialization.
+
+    :returns: The deserialized state with an instantiated process.
+    """
     deserialized = serialized.copy()
     protocol, address = serialized['address'].split(':', 1)
 
@@ -161,11 +172,11 @@ def __init__(self):
 
 
     def infer_schema(self, schema, state, top_state=None, path=None):
-        '''
+        """
         Given a schema fragment and an existing state with _type keys,
         return the full schema required to describe that state,
         and whatever state was hydrated (processes/steps) during this process
-        '''
+        """
 
         schema = schema or {}
         # TODO: deal with this