Added docstrings to several undocumented functions.

Author: fluencydoc

patterns/behavioral/memento.py

@@ -50,6 +50,11 @@ 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/dependency_injection.py

@@ -17,6 +17,15 @@ def __init__(self):
         self.time_provider = datetime.datetime.now
 
     def get_current_time_as_html_fragment(self):
+        """
+        Returns the current time as a string in 12-hour clock format with seconds and am/pm.
+        """
+        """
+        Returns the current time as a string in 12-hour clock format with seconds and am/pm.
+        """
+        """
+        Returns the current time as a string in 12-hour clock format with seconds and am/pm.
+        """
         current_time = self.time_provider()
         current_time_as_html_fragment = "<span class=\"tinyBoldText\">{}</span>".format(current_time)
         return current_time_as_html_fragment
@@ -61,6 +70,15 @@ def set_time_provider(self, time_provider: Callable):
         self.time_provider = time_provider
 
     def get_current_time_as_html_fragment(self):
+        """
+        Returns the current time as a string in 12-hour clock format with seconds and am/pm.
+        """
+        """
+        Returns the current time as a string in 12-hour clock format with seconds and am/pm.
+        """
+        """
+        Returns the current time as a string in 12-hour clock format with seconds and am/pm.
+        """
         current_time = self.time_provider()
         current_time_as_html_fragment = '<span class="tinyBoldText">{}</span>'.format(
             current_time

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:
@@ -50,6 +54,26 @@ def is_eager_to_contribute(self):
 
     @abc.abstractmethod
     def contribute(self):
+        """
+        This function is responsible for contributing to the common state of the project.
+        It adds a random number between 1 and 2 to problems, between 10 and
+        20 suggestions,
+        and it adds this class name to contributions. It also increments progress by a random number between 10 and 100.
+        """
+        """
+        :param self:
+        :returns None:
+        """
+        """
+        This function is responsible for contributing to the project.
+        It adds a random number of problems and suggestions, as well as adding its name to the
+        list of contributions.
+        """
+        """
+        This function adds a random number of problems and suggestions to the common state,
+        and also adds its name to the list of contributions. It also
+        increments progress by a random number between 10 and 100.
+        """
         raise NotImplementedError("Must provide implementation in subclass.")
 
 
@@ -59,6 +83,26 @@ def is_eager_to_contribute(self):
         return True
 
     def contribute(self):
+        """
+        This function is responsible for contributing to the common state of the project.
+        It adds a random number between 1 and 2 to problems, between 10 and
+        20 suggestions,
+        and it adds this class name to contributions. It also increments progress by a random number between 10 and 100.
+        """
+        """
+        :param self:
+        :returns None:
+        """
+        """
+        This function is responsible for contributing to the project.
+        It adds a random number of problems and suggestions, as well as adding its name to the
+        list of contributions.
+        """
+        """
+        This function adds a random number of problems and suggestions to the common state,
+        and also adds its name to the list of contributions. It also
+        increments progress by a random number between 10 and 100.
+        """
         self.blackboard.common_state["problems"] += random.randint(1, 10)
         self.blackboard.common_state["suggestions"] += random.randint(1, 10)
         self.blackboard.common_state["contributions"] += [self.__class__.__name__]
@@ -71,6 +115,26 @@ def is_eager_to_contribute(self):
         return random.randint(0, 1)
 
     def contribute(self):
+        """
+        This function is responsible for contributing to the common state of the project.
+        It adds a random number between 1 and 2 to problems, between 10 and
+        20 suggestions,
+        and it adds this class name to contributions. It also increments progress by a random number between 10 and 100.
+        """
+        """
+        :param self:
+        :returns None:
+        """
+        """
+        This function is responsible for contributing to the project.
+        It adds a random number of problems and suggestions, as well as adding its name to the
+        list of contributions.
+        """
+        """
+        This function adds a random number of problems and suggestions to the common state,
+        and also adds its name to the list of contributions. It also
+        increments progress by a random number between 10 and 100.
+        """
         self.blackboard.common_state["problems"] += random.randint(10, 20)
         self.blackboard.common_state["suggestions"] += random.randint(10, 20)
         self.blackboard.common_state["contributions"] += [self.__class__.__name__]
@@ -83,6 +147,26 @@ def is_eager_to_contribute(self):
         return True if self.blackboard.common_state["problems"] > 100 else False
 
     def contribute(self):
+        """
+        This function is responsible for contributing to the common state of the project.
+        It adds a random number between 1 and 2 to problems, between 10 and
+        20 suggestions,
+        and it adds this class name to contributions. It also increments progress by a random number between 10 and 100.
+        """
+        """
+        :param self:
+        :returns None:
+        """
+        """
+        This function is responsible for contributing to the project.
+        It adds a random number of problems and suggestions, as well as adding its name to the
+        list of contributions.
+        """
+        """
+        This function adds a random number of problems and suggestions to the common state,
+        and also adds its name to the list of contributions. It also
+        increments progress by a random number between 10 and 100.
+        """
         self.blackboard.common_state["problems"] += random.randint(1, 2)
         self.blackboard.common_state["suggestions"] += random.randint(10, 20)
         self.blackboard.common_state["contributions"] += [self.__class__.__name__]

patterns/other/graph_search.py

@@ -49,6 +49,18 @@ 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,18 @@ 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
+        """
+        """
+        Show information about a {item_type} item.
+        :param str item_name: the name of the {item_type} item to show information about
+        """
+        """
+        Prints the information of a given item.
+        :param str item_name: name of the item to be found
+        """
         try:
             item_info = self.model.get(item_name)
         except Exception: