attempt to avoid spell-checking code blocks as well as references.

ImperialCollegeLondon · Oct 25, 2024 · 8ec91e9 · 8ec91e9
1 parent 636467b
commit 8ec91e9
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 3 deletions.
diff --git a/.spellcheck.yml b/.spellcheck.yml
@@ -9,6 +9,12 @@ matrix:
     encoding: utf-8
   pipeline:
   - pyspelling.filters.markdown:
+      code_languages:  # specify languages to ignore in code blocks
+        - python
+        - plantuml
+        - zsh
+      ignore_patterns:  # custom pattern to ignore References section
+        - '## References\n(?:- .*\n)*'
   - pyspelling.filters.html:
       comments: false
       ignores:

diff --git a/docs/posts/design_patterns.md b/docs/posts/design_patterns.md
@@ -41,7 +41,7 @@ namely the `Strategy Pattern` which belongs to the class of Behavioural Patterns
 
 What are the ingredients do we need to be aware of to get started then?
 
-- i) As the patterns themselves are abstract in nature, we introduce the reader to their architecture via UML diagrams. UML stands for `Unified Modeling Language` and visualizes the way and links through which systems interact with each other. This makes it particularly useful to visualize software. You might say - we have barely started and yet are off to a detour? Not really - at least not without ulterior motive. Having fundamental knowledge about UML diagrams will make it easier to facilitate the transition from the anatomy of the Design Pattern to the actual code, as the UML diagram serves as the blueprint we use to translate the pattern to code.
+- i) As the patterns themselves are abstract in nature, we introduce the reader to their architecture via UML diagrams. UML stands for `Unified Modeling Language` and visualises the way and links through which systems interact with each other. This makes it particularly useful to visualise software. You might say - we have barely started and yet are off to a detour? Not really - at least not without ulterior motive. Having fundamental knowledge about UML diagrams will make it easier to facilitate the transition from the anatomy of the Design Pattern to the actual code, as the UML diagram serves as the blueprint we use to translate the pattern to code.
 - ii) The definition of the Design Pattern we wish to make use of.
 - iii) Some background of the application we apply the Design Pattern to. The author chose a common topic in finance, namely option pricing, specifically, European put and call options. Do not worry yet. We will introduce and explain the necessary vocabulary as well as the equations we implement as we go along.
 - iv) The actual implementation of pricing European options making use of the strategy pattern.
@@ -361,7 +361,7 @@ if __name__ == "__main__":
 In the currency of the contract, under the Black-Scholes model, the price of a European call and
 put options given the underlying stock are hence:
 
-```bash
+```zsh
 call price: 10.45 [monetary units].
 put price: 5.57 [monetary units].
 ```
@@ -431,7 +431,7 @@ We can translate this to Python like so:
 
 and obtain the following result:
 
-```bash
+```zsh
 call price: 10.45 [monetary units].
 put price: 5.57 [monetary units].
 present value of strike price: 95.12 [monetary units].

diff --git a/docs/posts/images/design_patterns/def_strategy_pattern.png b/docs/posts/images/design_patterns/def_strategy_pattern.png
diff --git a/docs/posts/images/design_patterns/option_pricing_using_strategy_pattern.png b/docs/posts/images/design_patterns/option_pricing_using_strategy_pattern.png