Updated readme

Author: Loumstar

README.md

@@ -1,20 +1,25 @@
 # BaseEvalutionFunctionLayer
-Base docker image for evaluation functions coded in python. This layer cannot function alone, it needs to be extended in a specific way by evaluation function it supports. 
 
-This layer encompases all the behaviour that is universal to all evaluation functions: 
+Base docker image for evaluation functions coded in python. This layer cannot function alone, it needs to be extended in a specific way by evaluation function it supports.
+
+This layer encompases all the behaviour that is universal to all evaluation functions:
+
 - Request and response schema validation
 - Unit testing setup
 - Function commands:
-  - `eval`: calls the function in the user-defined `evaluation.py` file
+  - `eval`: calls the evaluation function in the user-defined `evaluation.py` file.
+  - `preview`: calls the preview function in the user-defined `preview.py` file.
   - `healthcheck`: runs all unittests for schema testing as well as user-defined tests in `evaluation_tests.py`.
-  - `docs`: returns the `docs.md` user-defined file. 
+  - `docs`: returns the `docs.md` user-defined file.
 
-*Note: user-defined files are those provided by the evaluation function code meant to extend this layer*
+_Note: user-defined files are those provided by the evaluation function code meant to extend this layer_
 
 ## Behaviour and Usage
-Commands as passed in 'command' header from each request. By default (if not header is present), the function will run the `eval` command. 
+
+Commands as passed in 'command' header from each request. By default (if not header is present), the function will run the `eval` command.
 
 ## Requirements from the superseding layer
+
 This function makes references to files and functions which don't exist yet in this layer - those need to be provided by the superseding layer. They're shown here in the way a dockerfile might be extending it.
 
 ```dockerfile
@@ -41,8 +46,8 @@ RUN chmod 755 $(find . -type d)
 CMD [ "/app/app.handler" ]
 ```
 
-
 ### Operating Container Structure
+
 Since this is only just a base layer for eval functions, the repo's file structure won't match the file structure inside the built image, which can get confusing at times. This is what the `/app/` directory (where all our data is contained) will look like for an operational function:
 
 ```
@@ -55,20 +60,25 @@ Since this is only just a base layer for eval functions, the repo's file structu
    |  |____requests.py
    |  |____responses.py
    |  |____handling.py
+   |  |____commands.py
+   |  |____docs.py
+   |  |____parse.py
    |____tools
    |  |______init__.py
+   |  |____commands.py
    |  |____validate.py
    |  |____docs.py
    |  |____parse.py
    |  |____healthcheck.py
+   |  |____utils.py
    |____docs.md
    |____handler.py
    |____evaluation_tests.py
    |____evaluation.py
 ```
 
-
 ## Dev Notes
+
 Can run the following command to look around the container of a running function
 
 ```bash
@@ -80,5 +90,3 @@ From a container which exposes port 8080 to the real port 9000, requests can be
 ```
 http://localhost:9000/2015-03-31/functions/function/invocations
 ```
-
-

handler.py

@@ -73,7 +73,7 @@ def handler(event: JsonType, _: JsonType = {}) -> HandlerResponse:
     except Exception as e:
         error = ErrorResponse(
             message="An exception was raised while "
-            "executing the preview function.",
+            "executing the evaluation function.",
             detail=(str(e) if str(e) != "" else repr(e)),
         )