brennen/PyPattyrn
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

update docstrings for creational patterns

Browse Source
This commit is contained in:
Nathan Mann
2017-10-20 22:22:24 -05:00
parent a0485a17b1
commit c7eddaaf03
5 changed files with 7 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
pypattyrn/creational/builder.py
View File

@@ -5,7 +5,7 @@ class Director(object, metaclass=ABCMeta):
""" """
Abstract director class, responsible for using a builder to fully construct an object. Abstract director class, responsible for using a builder to fully construct an object.
- External Usage documentation: U{https://github.com/tylerlaberge/PyPatterns/wiki/Creational-Pattern-Usage} - External Usage documentation: U{https://github.com/tylerlaberge/PyPattyrn#builder-pattern}
- External Builder Pattern documentation: U{https://en.wikipedia.org/wiki/Builder_pattern} - External Builder Pattern documentation: U{https://en.wikipedia.org/wiki/Builder_pattern}
""" """
@@ -39,7 +39,7 @@ class Builder(object, metaclass=ABCMeta):
""" """
Abstract builder class, responsible for constructing various pieces of an object. Abstract builder class, responsible for constructing various pieces of an object.
- External Usage documentation: U{https://github.com/tylerlaberge/PyPatterns/wiki/Creational-Pattern-Usage} - External Usage documentation: U{https://github.com/tylerlaberge/PyPattyrn#builder-pattern}
- External Builder Pattern documentation: U{https://en.wikipedia.org/wiki/Builder_pattern} - External Builder Pattern documentation: U{https://en.wikipedia.org/wiki/Builder_pattern}
""" """

4
pypattyrn/creational/factory.py
View File

@@ -7,7 +7,7 @@ class Factory(object, metaclass=ABCMeta):
All Factories should inherit this class and overwrite the create method. All Factories should inherit this class and overwrite the create method.
- External Usage documentation: U{https://github.com/tylerlaberge/PyPatterns/wiki/Creational-Pattern-Usage} - External Usage documentation: U{https://github.com/tylerlaberge/PyPattyrn#factory-pattern}
- External Factory Pattern documentation: U{https://en.wikipedia.org/wiki/Factory_method_pattern} - External Factory Pattern documentation: U{https://en.wikipedia.org/wiki/Factory_method_pattern}
""" """
@abstractmethod @abstractmethod
@@ -26,7 +26,7 @@ class AbstractFactory(Factory, metaclass=ABCMeta):
""" """
Abstract Factory Class as part of the AbstractFactory design pattern. Abstract Factory Class as part of the AbstractFactory design pattern.
- External Usage documentation: U{https://github.com/tylerlaberge/PyPatterns/wiki/Creational-Pattern-Usage} - External Usage documentation: U{https://github.com/tylerlaberge/PyPattyrn#abstract-factory-pattern}
- External Abstract Factory Pattern documentation: U{https://en.wikipedia.org/wiki/Abstract_factory_pattern} - External Abstract Factory Pattern documentation: U{https://en.wikipedia.org/wiki/Abstract_factory_pattern}
""" """
def __init__(self): def __init__(self):

2
pypattyrn/creational/pool.py
View File

@@ -7,7 +7,7 @@ class Reusable(Originator, metaclass=ABCMeta):
""" """
An abstract reusable class. An abstract reusable class.
- External Usage documentation: U{https://github.com/tylerlaberge/PyPatterns/wiki/Creational-Pattern-Usage} - External Usage documentation: U{https://github.com/tylerlaberge/PyPattyrn#object-pool-pattern}
- External Object Pool Pattern documentation: U{https://en.wikipedia.org/wiki/Object_pool_pattern} - External Object Pool Pattern documentation: U{https://en.wikipedia.org/wiki/Object_pool_pattern}
""" """
def __init__(self): def __init__(self):

2
pypattyrn/creational/prototype.py
View File

@@ -6,7 +6,7 @@ class Prototype(object):
""" """
Prototype design pattern abstract class. Prototype design pattern abstract class.
- External Usage documentation: U{https://github.com/tylerlaberge/PyPatterns/wiki/Creational-Pattern-Usage} - External Usage documentation: U{https://github.com/tylerlaberge/PyPattyrn#prototype-pattern}
- External Prototype Pattern documentation: U{https://en.wikipedia.org/wiki/Prototype_pattern} - External Prototype Pattern documentation: U{https://en.wikipedia.org/wiki/Prototype_pattern}
""" """
def prototype(self, **attributes): def prototype(self, **attributes):

2
pypattyrn/creational/singleton.py
View File

@@ -4,7 +4,7 @@ class Singleton(type):
Enforces any object using this metaclass to only create a single instance. Enforces any object using this metaclass to only create a single instance.
- External Usage documentation: U{https://github.com/tylerlaberge/PyPatterns/wiki/Creational-Pattern-Usage} - External Usage documentation: U{https://github.com/tylerlaberge/PyPattyrn#singleton-pattern}
- External Singleton Pattern documentation: U{https://en.wikipedia.org/wiki/Singleton_pattern} - External Singleton Pattern documentation: U{https://en.wikipedia.org/wiki/Singleton_pattern}
""" """
__instance = None __instance = None