Amends from PR feedback

Author: Andy Babic

docs/guides/defining-template-context.md

@@ -40,7 +40,7 @@ Let's assume you have the following template:
 {% endif %}
 ```
 
-You might define a `yaml` file similar to this to provide fake data:
+You might define a YAML file similar to this to provide fake data:
 
 ```yaml
 name: My example pattern
@@ -56,12 +56,12 @@ context:
               link: /page2
 ```
 
-You can define a list or a dict or anything that [`PyYAML`](http://pyyaml.org/wiki/PyYAMLDocumentation) allows you to create in `yaml` format without creating a custom objects.
+You can define a list or a dict or anything that [`PyYAML`](http://pyyaml.org/wiki/PyYAMLDocumentation) allows you to create in YAML format without creating a custom objects.
 
 
 ## Modifying template contexts with Python
 
-While most objects can be faked with `yaml`, Django has a few common constructs that are difficult to replicate. For example: `Form` and `Paginator` instances. To help with this, django-pattern library allows you to register any number of 'context modifiers'. Context modifiers are simply Python functions that accept the `context` dictionary generated from the `yaml` file, and can make additions or updates to it as necessary. For convenience, they also receive the current `HttpRequest` as `request`.
+While most objects can be faked with YAML, Django has a few common constructs that are difficult to replicate. For example: `Form` and `Paginator` instances. To help with this, django-pattern-library allows you to register any number of 'context modifiers'. Context modifiers are simply Python functions that accept the `context` dictionary generated from the YAML file, and can make additions or updates to it as necessary. For convenience, they also receive the current `HttpRequest` as `request`.
 
 Context modifiers can easily be registered using the `register_context_modifier` decorator. Here is a simple example:
 

pattern_library/__init__.py

@@ -1,7 +1,18 @@
-from .context_modifiers import register_context_modifier  # NOQA
+from .context_modifiers import register_context_modifier
 
 default_app_config = 'pattern_library.apps.PatternLibraryAppConfig'
 
+__all__ = [
+    'DEFAULT_SETTINGS',
+    'get_setting',
+    'get_pattern_template_suffix',
+    'get_pattern_base_template_name',
+    'get_base_template_names',
+    'get_sections',
+    'get_pattern_context_var_name',
+    'register_context_modifier',
+]
+
 DEFAULT_SETTINGS = {
     # PATTERN_BASE_TEMPLATE_NAME is the template that fragments will be wrapped with.
     # It should include any required CSS and JS and output

pattern_library/context_modifiers.py

@@ -9,6 +9,11 @@
 GENERIC_CM_KEY = "__generic__"
 ORDER_ATTR_NAME = "__cm_order"
 
+__all__ = [
+    "ContextModifierRegistry",
+    "register_context_modifier"
+]
+
 
 class ContextModifierRegistry(defaultdict):
     def __init__(self):
@@ -24,11 +29,11 @@ def register(self, func: Callable, template: str = None, order: int = 0) -> None
             )
         if not accepts_kwarg(func, "context"):
             raise ImproperlyConfigured(
-                f"Context modifiers must accept a 'context' argument. {func} does not."
+                f"Context modifiers must accept a 'context' keyword argument. {func} does not."
             )
         if not accepts_kwarg(func, "request"):
             raise ImproperlyConfigured(
-                f"Context modifiers must accept a 'request' argument. {func} does not."
+                f"Context modifiers must accept a 'request' keyword argument. {func} does not."
             )
 
         key = template or GENERIC_CM_KEY

tests/tests/test_context_modifiers.py

@@ -46,15 +46,15 @@ def test_validation(self):
         with self.assertRaisesRegex(ImproperlyConfigured, "must be callables"):
             registry.register(0, template=atom_template)
         with self.assertRaisesRegex(
-            ImproperlyConfigured, "must accept a 'request' argument"
+            ImproperlyConfigured, "must accept a 'request' keyword argument"
         ):
             registry.register(accepts_context_only, template=atom_template)
         with self.assertRaisesRegex(
-            ImproperlyConfigured, "must accept a 'context' argument"
+            ImproperlyConfigured, "must accept a 'context' keyword argument"
         ):
             registry.register(accepts_request_only, template=atom_template)
 
-    def test_registred_without_ordering(self):
+    def test_registered_without_ordering(self):
         registry.register(modifier_1, template=atom_template)
         registry.register(modifier_2, template=atom_template)
         registry.register(modifier_3, template=atom_template)