diff --git a/docs/schemas/fields.md b/docs/schemas/fields.md index 964eb16..eadd3c3 100644 --- a/docs/schemas/fields.md +++ b/docs/schemas/fields.md @@ -2,7 +2,7 @@ Vibora has a special class called "Field" to represent each field of a schema. You can build any kind of validation rules using this class -but to avoid repeat yourself there a few builtin ones. +but to avoid repeating yourself there a few builtin ones. There are a few must-know attributes of this class: 1) **required** -> By default all declared fields in a schema are required which means @@ -45,4 +45,4 @@ class NewUserSchema(Schema): ``` > There is a special attribute called `strict` to allow this field to cast -integers and similar types to a string instead of raising an error. \ No newline at end of file +integers and similar types to a string instead of raising an error. diff --git a/docs/templates/engine.md b/docs/templates/engine.md index 8f28c30..a092cf6 100644 --- a/docs/templates/engine.md +++ b/docs/templates/engine.md @@ -1,21 +1,21 @@ ### Vibora Template Engine (VTE) -Although server-side rendering is not main-stream nowadays, Vibora has +Although server-side rendering is not mainstream nowadays, Vibora has its own template engine. The idea was to build something like Jinja2 but with async users as first class citizens. Jinja2 is already heavily optimized but we tried to beat it in benchmarks. -Jinja2 also prevents you to pass parameters to functions and a few other +Jinja2 also prevents passing parameters to functions and a few other restrictions which are often a good idea but don't comply with Vibora -philosophy of not getting into your way. +philosophy of not getting in your way. The syntax is pretty similar to Jinja2, templates are often compatible. -The render process is async which means you can pass coroutines to your +The rendering process is async which means you can pass coroutines to your templates and call them as regular functions, Vibora will do the magic. VTE has hot-reloading so we can swap templates at run-time. This is enabled by default in debug mode so you have a fast iteration cycle while building your app. -Although VTE **do not aim to be sandboxed** it tries hard to prevent the templates from leaking access to outside context. +Although VTE **does not aim to be sandboxed** it tries hard to prevent the templates from leaking access to outside context. diff --git a/docs/testing/started.md b/docs/testing/started.md index cea0539..41a146e 100644 --- a/docs/testing/started.md +++ b/docs/testing/started.md @@ -1,6 +1,6 @@ ### Testing -Testing is the most important part of any project with considerably +Testing is the most important part of any project of considerable size and yet of one of the most ignored steps. Vibora has a builtin and fully featured async HTTP client and