Skip to content

Commit

Permalink
Merge pull request metosin#252 from aarongroom/fix/misc-documentation…
Browse files Browse the repository at this point in the history
…-edits

Fix some documentation wording
  • Loading branch information
miikka authored Apr 3, 2019
2 parents 727858e + ffc4d8e commit 51462e3
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion doc/basics/name_based_routing.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# 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:

Expand Down
2 changes: 1 addition & 1 deletion doc/basics/route_conflicts.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# 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.

Expand Down
2 changes: 1 addition & 1 deletion doc/basics/route_data_validation.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# 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.

Expand Down

0 comments on commit 51462e3

Please sign in to comment.