Improving global settings file

* Update global settings documentation
dymmond · Oct 24, 2023 · 9c047a8 · 9c047a8
1 parent c709866
commit 9c047a8
Show file tree

Hide file tree

Showing 3 changed files with 440 additions and 118 deletions.
diff --git a/docs/references/application/settings.md b/docs/references/application/settings.md
@@ -35,3 +35,4 @@ app.settings
         - "!^model_config"
         - "!^ipython_args"
         - "!^ptpython_config_file"
+        - "!^async_exit_config"
diff --git a/esmerald/applications.py b/esmerald/applications.py
@@ -592,7 +592,7 @@ async def intercept(self, scope: "Scope", receive: "Receive", send: "Send") -> N
             Optional["Dependencies"],
             Doc(
                 """
-                A list of global dependencies. These dependencies will be
+                A dictionary of global dependencies. These dependencies will be
                 applied to each **path** of the application.
 
                 Read more about [Dependencies](https://esmerald.dev/dependencies/).
@@ -644,11 +644,12 @@ def is_valid(number: int) -> bool:
             Optional["OpenAPIConfig"],
             Doc(
                 """
-                An instance of [CRSFConfig](https://esmerald.dev/configurations/openapi/config/).
+                An instance of [OpenAPIConfig](https://esmerald.dev/configurations/openapi/config/).
 
                 This object is then used by Esmerald to create the [OpenAPI](https://esmerald.dev/openapi/) documentation.
 
-                **Note**: Here is where the defaults for Esmerald OpenAPI are overriden.
+                **Note**: Here is where the defaults for Esmerald OpenAPI are overriden and if
+                this object is passed, then the previous defaults of the settings are ignored.
 
                 !!! Tip
                     This is the way you could override the defaults all in one go