added usage documentation links to docstrings.

This commit is contained in:
tylerlaberge
2016-09-10 17:27:50 -04:00
parent 7f02aa9866
commit 5ea8a13206
16 changed files with 53 additions and 26 deletions
+4 -2
View File
@@ -7,7 +7,8 @@ class Reusable(Originator, metaclass=ABCMeta):
"""
An abstract reusable class.
External Object Pool Pattern documentation: U{https://en.wikipedia.org/wiki/Object_pool_pattern}
- External Usage documentation: U{https://github.com/tylerlaberge/PyPatterns/wiki/Creational-Pattern-Usage}
- External Object Pool Pattern documentation: U{https://en.wikipedia.org/wiki/Object_pool_pattern}
"""
def __init__(self):
"""
@@ -28,7 +29,8 @@ class Pool(object):
"""
An Object Pool design pattern implementation.
External Object Pool Pattern documentation: U{https://en.wikipedia.org/wiki/Object_pool_pattern}
- External Usage documentation: U{https://github.com/tylerlaberge/PyPatterns/wiki/Creational-Pattern-Usage}
- External Object Pool Pattern documentation: U{https://en.wikipedia.org/wiki/Object_pool_pattern}
"""
def __init__(self, reusable_class, *args, **kwargs):
"""
+2 -1
View File
@@ -6,7 +6,8 @@ class Prototype(object):
"""
Prototype design pattern abstract class.
External Prototype Pattern documentation: U{https://en.wikipedia.org/wiki/Prototype_pattern}
- External Usage documentation: U{https://github.com/tylerlaberge/PyPatterns/wiki/Creational-Pattern-Usage}
- External Prototype Pattern documentation: U{https://en.wikipedia.org/wiki/Prototype_pattern}
"""
def prototype(self, **attributes):
"""
+2 -1
View File
@@ -4,7 +4,8 @@ class Singleton(type):
Enforces any object using this metaclass to only create a single instance.
External Singleton Pattern documentation: U{https://en.wikipedia.org/wiki/Singleton_pattern}
- External Usage documentation: U{https://github.com/tylerlaberge/PyPatterns/wiki/Creational-Pattern-Usage}
- External Singleton Pattern documentation: U{https://en.wikipedia.org/wiki/Singleton_pattern}
"""
__instance = None