updates

Author: Sean-Bradley

abstract_factory/README.md

@@ -46,9 +46,11 @@ python ./abstract_factory/abstract_factory_concept.py
 
 ## Abstract Factory Example Use Case
 
-An example use case may be that you have a furniture shop front. You sell many different kinds of furniture. You sell chairs and tables. And they are manufactured at different factories using different unrelated processes that are not important for your concern. You only need the factory to deliver.
+*...Refer to Book or Videos for extra content.*
 
-You can create an extra module called `FurnitureFactory`, to handle the chair and table factories, thus removing the implementation details from the client.
+<!-- An example use case may be that you have a furniture shop front. You sell many different kinds of furniture. You sell chairs and tables. And they are manufactured at different factories using different unrelated processes that are not important for your concern. You only need the factory to deliver.
+
+You can create an extra module called `FurnitureFactory`, to handle the chair and table factories, thus removing the implementation details from the client. -->
 
 ## Abstract Factory Example UML Diagram
 

builder/README.md

@@ -38,9 +38,11 @@ The Builder and Factory patterns are very similar in the fact they both instanti
 
 ## Source Code
 
-1. Client creates the **Director**.
+*...Refer to Book or Videos for extra content.*
+
+<!-- 1. Client creates the **Director**.
 2. The Client calls the Directors `construct()` method that manages each step of the build process.
-3. The Director returns the product to the client or alternatively could also provide a method for the client to retrieve it later.
+3. The Director returns the product to the client or alternatively could also provide a method for the client to retrieve it later. -->
 
 ## Output
 
@@ -51,13 +53,15 @@ python ./builder/builder_concept.py
 
 ## Example Use Case
 
-Using the Builder Pattern in the context of a House Builder. 
+*...Refer to Book or Videos for extra content.*
+
+<!-- Using the Builder Pattern in the context of a House Builder. 
 
 There are multiple directors that can create their own complex objects.
 
 Note that in the `IglooDirector` class, not all of the methods of the `HouseBuilder` were called. 
 
-The builder can construct complex objects in any order and include/exclude whichever parts it likes.
+The builder can construct complex objects in any order and include/exclude whichever parts it likes. -->
 
 ## Example UML Diagram
 

chain_of_responsibility/README.md

@@ -39,7 +39,9 @@ The chain that the object will pass through is normally dynamic at runtime, alth
 
 ## Source Code
 
-In this concept code, a chain is created with a default first successor. A number is passed to a successor, which then does a random test, and depending on the result will modify the number and then pass it onto the next successor. The process is randomized and will end at some point when there are no more successors designated.
+*...Refer to Book or Videos for extra content.*
+
+<!-- In this concept code, a chain is created with a default first successor. A number is passed to a successor, which then does a random test, and depending on the result will modify the number and then pass it onto the next successor. The process is randomized and will end at some point when there are no more successors designated. -->
 
 ## Output
 
@@ -57,11 +59,14 @@ Finished result = -1.5
 
 ## Example Use Case
 
+*...Refer to Book or Videos for extra content.*
+
+<!-- 
 In the ATM example below, the chain is hard coded in the client first to dispense amounts of £50s, then £20s and then £10s in order. 
 
 This default chain order helps to ensure that the minimum number of notes will be dispensed. Otherwise, it might dispense 5 x £10 when it would have been better to dispense 1 x £50.
 
-Each successor may be re-called recursively for each denomination depending on the value that was requested for withdrawal.
+Each successor may be re-called recursively for each denomination depending on the value that was requested for withdrawal. -->
 
 ## Example UML Diagram
 

command/README.md

@@ -51,15 +51,17 @@ Uses:
 
 ## Source Code
 
-The Client instantiates a Receiver that accepts certain commands.
+*...Refer to Book or Videos for extra content.*
+
+<!-- The Client instantiates a Receiver that accepts certain commands.
 
 The Client then creates two Command objects that will call one of the specific commands on the Receiver.
 
 The Client then creates an Invoker, E.g., a user interface with buttons, and registers both Commands into the Invokers dictionary of commands.
 
 The Client doesn't call the receivers commands directly, but the via the Invoker, which then calls the registered Command objects `execute()` method.
 
-This abstraction between the invoker, command and receiver, allows the Invoker to add extra functionality such as history, replay, UNDO/REDO, logging, alerting and any other useful things that may be required.
+This abstraction between the invoker, command and receiver, allows the Invoker to add extra functionality such as history, replay, UNDO/REDO, logging, alerting and any other useful things that may be required. -->
 
 ## Output
 
@@ -73,13 +75,15 @@ Executing Command 2
 
 ## Example Use Case
 
-This will be a smart light switch. 
+*...Refer to Book or Videos for extra content.*
+
+<!-- This will be a smart light switch. 
 
 This light switch will keep a history of each time one of its commands was called. 
 
 And it can replay its commands. 
 
-A smart light switch could be extended in the future to be called remotely or automated depending on sensors.
+A smart light switch could be extended in the future to be called remotely or automated depending on sensors. -->
 
 ## Example UML Diagram
 

factory/README.md

@@ -48,11 +48,13 @@ The Factory pattern is really about adding that extra abstraction between the ob
 
 ## Source Code
 
-In this concept example, the client wants an object named `b`
+*...Refer to Book or Videos for extra content.*
+
+<!-- In this concept example, the client wants an object named `b`
 
 Rather than creating `b` directly in the client, it asks the creator (factory) for the object instead. 
 
-The factory finds the relevant class using some kind of logic from the attributes of the request. It then asks the subclass to instantiate the new object which it then returns as a reference back to the client asking for it.
+The factory finds the relevant class using some kind of logic from the attributes of the request. It then asks the subclass to instantiate the new object which it then returns as a reference back to the client asking for it. -->
 
 ## Output
 
@@ -63,11 +65,13 @@ ConcreteProductB
 
 ## Example Use Case
 
-An example use case is a user interface where the user can select from a menu of items, such as chairs. 
+*...Refer to Book or Videos for extra content.*
+
+<!-- An example use case is a user interface where the user can select from a menu of items, such as chairs. 
 
 The user has been given a choice using some kind of navigation interface, and it is unknown what choice, or how many the user will make until the application is actually running and the user starts using it.
 
-So, when the user selected the chair, the factory then takes some property involved with that selection, such as an ID, Type or other attribute and then decides which relevant subclass to instantiate in order to return the appropriate object.
+So, when the user selected the chair, the factory then takes some property involved with that selection, such as an ID, Type or other attribute and then decides which relevant subclass to instantiate in order to return the appropriate object. -->
 
 ## Factory Example UML Diagram
 

observer/README.md

@@ -59,15 +59,17 @@ If updates on the observer end are allowed to suffer from some delay, then a pul
 
 ## Source Code
 
-A Subject (Observable) is created.
+*...Refer to Book or Videos for extra content.*
+
+<!-- A Subject (Observable) is created.
 
 Two Observers are created. They could be across a network, but for demonstration purposes are within the same client.
 
 The Subject notifies the Observers.
 
 One of the Observers unsubscribes, 
 
-The Subject notifies the remaining Observer again.
+The Subject notifies the remaining Observer again. -->
 
 ## Output
 
@@ -80,7 +82,9 @@ Observer id:2084220160272 received ('Second Notification', {'A': 1, 'B': 2, 'C':
 
 ## Example Use Case
 
-This example mimics the **MVC** approach described earlier.
+*...Refer to Book or Videos for extra content.*
+
+<!-- This example mimics the **MVC** approach described earlier.
 
 There is an external process called a `DataController`, and a client process that holds a `DataModel` and multiple `DataViews` which are a Pie graph, Bar graph and Table view. 
 
@@ -94,7 +98,7 @@ The hypothetical external `DataController` then updates the external data, and t
 
 Note that in reality this example would be much more complex if multiple servers are involved. I am keeping it brief to demonstrate one possible use case of the observer pattern.
 
-Also note that in the `DataController`, the references to the observers are contained in a [Set](#python-set), while in the `DataModel` I have used a [Dictionary](/singleton#python-dictionary) instead, so that you can see an alternate approach.
+Also note that in the `DataController`, the references to the observers are contained in a [Set](#python-set), while in the `DataModel` I have used a [Dictionary](/singleton#python-dictionary) instead, so that you can see an alternate approach. -->
 
 ## Example UML Diagram
 

visitor/README.md

@@ -42,13 +42,15 @@ Similar to the template pattern it could be used to output different versions of
 
 ## Source Code
 
-In the concept code below, a hierarchy of any object is created. It is similar to a simplified composite. The objects of `Element` can also contain a hierarchy of sub elements.
+*...Refer to Book or Videos for extra content.*
+
+<!-- In the concept code below, a hierarchy of any object is created. It is similar to a simplified composite. The objects of `Element` can also contain a hierarchy of sub elements.
 
 The `Element` class could also consist of many variations, but this example uses only one.
 
 Rather than writing specific code inside all these elements every time I wanted to handle a new custom operation, I can implement the `IVisitable` interface and create the `accept()` method which allows the Visitor to pass through it and access the Elements internal attributes.
 
-Two different Visitor classes are created, `PrintElementNamesVisitor` and `CalculateElementTotalsVisitor` . They are instantiated and passed through the existing Object hierarchy using the same `IVisitable` interface.
+Two different Visitor classes are created, `PrintElementNamesVisitor` and `CalculateElementTotalsVisitor` . They are instantiated and passed through the existing Object hierarchy using the same `IVisitable` interface. -->
 
 ## Output
 
@@ -63,13 +65,15 @@ A
 
 ## Visitor Example Use Case
 
-In the example, the client creates a car with parts. 
+*...Refer to Book or Videos for extra content.*
+
+<!-- In the example, the client creates a car with parts. 
 
 The car and parts inherit an abstract car parts class with predefined property getters and setters. 
 
 Instead of creating methods in the car parts classes and abstract class that run bespoke methods, the car parts can all implement the `IVisitor` interface.
 
-This allows for the later creation of Visitor objects to run specific tasks on the existing hierarchy of objects.
+This allows for the later creation of Visitor objects to run specific tasks on the existing hierarchy of objects. -->
 
 ## Visitor Example UML Diagram