Merge pull request #386 from mjanos5/trelent-documentation

Added docstrings to several undocumented functions

Author: faif

patterns/behavioral/memento.py

@@ -50,6 +50,12 @@ def __init__(self, method):
         self.method = method
 
     def __get__(self, obj, T):
+        """
+        A decorator that makes a function transactional.
+
+        :param method: The function to be decorated.
+        """
+
         def transaction(*args, **kwargs):
             state = memento(obj)
             try:

patterns/creational/lazy_evaluation.py

@@ -36,6 +36,12 @@ def __get__(self, obj, type_):
 
 
 def lazy_property2(fn):
+    """
+    A lazy property decorator.
+
+    The function decorated is called the first time to retrieve the result and
+    then that calculated result is used the next time you access the value.
+    """
     attr = "_lazy__" + fn.__name__
 
     @property

patterns/other/blackboard.py

@@ -32,6 +32,10 @@ def __init__(self, blackboard):
         self.blackboard = blackboard
 
     def run_loop(self):
+        """
+        This function is a loop that runs until the progress reaches 100.
+        It checks if an expert is eager to contribute and then calls its contribute method.
+        """
         while self.blackboard.common_state["progress"] < 100:
             for expert in self.blackboard.experts:
                 if expert.is_eager_to_contribute:

patterns/other/graph_search.py

@@ -49,6 +49,20 @@ def find_shortest_path_dfs(self, start, end, path=None):
         return shortest
 
     def find_shortest_path_bfs(self, start, end):
+        """
+        Finds the shortest path between two nodes in a graph using breadth-first search.
+
+        :param start: The node to start from.
+        :type start: str or int
+        :param end: The node to find the shortest path to.
+            :type end: str or int
+
+            :returns queue_path_to_end, dist_to[end]: A list of nodes
+        representing the shortest path from `start` to `end`, and a dictionary
+        mapping each node in the graph (except for `start`) with its distance from it
+        (in terms of hops). If no such path exists, returns an empty list and an empty
+        dictionary instead.
+        """
         queue = [start]
         dist_to = {start: 0}
         edge_to = {}

patterns/structural/front_controller.py

@@ -22,6 +22,12 @@ def __init__(self):
         self.tablet_view = TabletView()
 
     def dispatch(self, request):
+        """
+        This function is used to dispatch the request based on the type of device.
+        If it is a mobile, then mobile view will be called and if it is a tablet,
+        then tablet view will be called.
+        Otherwise, an error message will be printed saying that cannot dispatch the request.
+        """
         if request.type == Request.mobile_type:
             self.mobile_view.show_index_page()
         elif request.type == Request.tablet_type:
@@ -37,6 +43,9 @@ def __init__(self):
         self.dispatcher = Dispatcher()
 
     def dispatch_request(self, request):
+        """
+        This function takes a request object and sends it to the dispatcher.
+        """
         if isinstance(request, Request):
             self.dispatcher.dispatch(request)
         else:

patterns/structural/mvc.py

@@ -99,6 +99,10 @@ def show_items(self):
         self.view.show_item_list(item_type, items)
 
     def show_item_information(self, item_name):
+        """
+        Show information about a {item_type} item.
+        :param str item_name: the name of the {item_type} item to show information about
+        """
         try:
             item_info = self.model.get(item_name)
         except Exception: