luciano/reitit
1
0
Fork 0
mirror of https://github.com/metosin/reitit.git synced 2025-12-22 18:41:10 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge pull request #482 from keoko/fix-typos

Browse source 
fix documentation typos
This commit is contained in:
Miikka Koskinen 2021-04-09 14:49:09 +03:00 committed by GitHub
commit b8110f1e40
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 12 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
doc/basics/route_syntax.md
View file

@ -132,7 +132,7 @@ Routes are just data, so it's easy to create them programmatically:
### Explicit path-parameter syntax ### Explicit path-parameter syntax
Router options `:syntax` allows the path-parameter syntax to be explicitely defined. It takes a keyword or set of keywords as a value. Valid values are `:colon` and `:bracket`. Default value is `#{:colon :bracket}`. Router options `:syntax` allows the path-parameter syntax to be explicitly defined. It takes a keyword or set of keywords as a value. Valid values are `:colon` and `:bracket`. Default value is `#{:colon :bracket}`.
With defaults: With defaults:

9
doc/basics/router.md
View file

@ -85,9 +85,10 @@ As routes are defined as plain data, it's easy to merge multiple route trees int
["/ping" ::ping] ["/ping" ::ping]
["/db" ::db]]) ["/db" ::db]])
(r/router (def router
[admin-routes (r/router
user-routes]) [admin-routes
user-routes]))
``` ```
Merged route tree: Merged route tree:
@ -109,6 +110,6 @@ When router is created, the following steps are done:
* route arguments are expanded (via `:expand` option) * route arguments are expanded (via `:expand` option)
* routes are coerced (via `:coerce` options) * routes are coerced (via `:coerce` options)
* route tree is compiled (via `:compile` options) * route tree is compiled (via `:compile` options)
* [route conflicts](advanced/route_conflicts.md) are resolved (via `:conflicts` options) * [route conflicts](route_conflicts.md) are resolved (via `:conflicts` options)
* optionally, route data is validated (via `:validate` options) * optionally, route data is validated (via `:validate` options)
* [router implementation](../advanced/different_routers.md) is automatically selected (or forced via `:router` options) and created * [router implementation](../advanced/different_routers.md) is automatically selected (or forced via `:router` options) and created

10
doc/coercion/malli_coercion.md
View file

@ -49,11 +49,13 @@ Failing coercion:
Using `create` with options to create the coercion instead of `coercion`: Using `create` with options to create the coercion instead of `coercion`:
```clj ```clj
(require '[malli.util :as mu])
(reitit.coercion.malli/create (reitit.coercion.malli/create
{:transformers {:body {:default default-transformer-provider {:transformers {:body {:default reitit.coercion.malli/default-transformer-provider
:formats {"application/json" json-transformer-provider}} :formats {"application/json" reitit.coercion.malli/json-transformer-provider}}
:string {:default string-transformer-provider} :string {:default reitit.coercion.malli/string-transformer-provider}
:response {:default default-transformer-provider}} :response {:default reitit.coercion.malli/default-transformer-provider}}
;; set of keys to include in error messages ;; set of keys to include in error messages
:error-keys #{:type :coercion :in :schema :value :errors :humanized #_:transformed} :error-keys #{:type :coercion :in :schema :value :errors :humanized #_:transformed}
;; schema identity function (default: close all map schemas) ;; schema identity function (default: close all map schemas)