Merge branch 'trelent-documentation' of https://github.com/fluencydoc/python-patterns into trelent-documentation

Author: fluencydoc

patterns/dependency_injection.py

@@ -17,15 +17,6 @@ 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
@@ -70,15 +61,6 @@ 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

@@ -54,26 +54,6 @@ 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.")
 
 
@@ -83,26 +63,6 @@ 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__]
@@ -115,26 +75,6 @@ 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__]
@@ -147,26 +87,6 @@ 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/structural/mvc.py

@@ -103,14 +103,6 @@ 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: