luciano/reitit
1
0
Fork 0
mirror of https://github.com/metosin/reitit.git synced 2025-12-17 08:21:11 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge pull request #252 from aarongroom/fix/misc-documentation-edits

Browse source 
Fix some documentation wording
This commit is contained in:
Miikka Koskinen 2019-04-03 08:53:10 +03:00 committed by GitHub
commit 51462e345e
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 3 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
doc/basics/name_based_routing.md
View file

@ -1,6 +1,6 @@
# Name-based (reverse) Routing # Name-based (reverse) Routing
All routes which have `:name` route data defined, can also be matched by name. All routes which have `:name` route data defined can also be matched by name.
Given a router: Given a router:

2
doc/basics/route_conflicts.md
View file

@ -1,6 +1,6 @@
# Route Conflicts # Route Conflicts
We should fast if a router contains conflicting paths or route names. We should fail fast if a router contains conflicting paths or route names.
When a `Router` is created via `reitit.core/router`, both path and route name conflicts are checked automatically. By default, in case of conflict, an `ex-info` is thrown with a descriptive message. In some (legacy api) cases, path conflicts should be allowed and one can override the path conflict resolution via `:conflicts` router option. When a `Router` is created via `reitit.core/router`, both path and route name conflicts are checked automatically. By default, in case of conflict, an `ex-info` is thrown with a descriptive message. In some (legacy api) cases, path conflicts should be allowed and one can override the path conflict resolution via `:conflicts` router option.

2
doc/basics/route_data_validation.md
View file

@ -1,6 +1,6 @@
# Route Data Validation # Route Data Validation
Route data can be anything, so it's easy to do go wrong. Accidentally adding a `:role` key instead of `:roles` might hinder the whole routing app without any authorization in place. Route data can be anything, so it's easy to go wrong. Accidentally adding a `:role` key instead of `:roles` might hinder the whole routing app without any authorization in place.
To fail fast, we could use the custom `:coerce` and `:compile` hooks to apply data validation and throw exceptions on first sighted problem. To fail fast, we could use the custom `:coerce` and `:compile` hooks to apply data validation and throw exceptions on first sighted problem.