Improve docs

Author: ondrej-tucek

lib/validatex/validation.ex

@@ -150,9 +150,9 @@ defmodule Validatex.Validation do
  "name" => {:field, "bar", :not_validated},
  "surname" => {:field, "foo", {:valid, "foo"}}
  }
- iex> Validatex.Validation.apply(data,["name", "surname"], & &1)
+ iex> Validatex.Validation.apply(data, ["name", "surname"], & &1)
  {:invalid, "'name' field isn't valid.'"}
- iex> Validatex.Validation.apply(data,["surname"],
+ iex> Validatex.Validation.apply(data, ["surname"],
  ...> fn %{"surname" => s} -> %{"surname" => String.capitalize(s)} end)
  {:valid, %{"surname" => "Foo"}}
 

lib/validatex/validators.ex

@@ -3,13 +3,13 @@ defmodule Validatex.Validators do
  This module provides a few functions for validating data.
 
  All functions return [Result](https://hexdocs.pm/result/api-reference.html).
- It means, if an input value is correct, function returns a tuple `{:ok, val}`.
- If not then `{:error, "msg"}`.
+ It means, if an input value is correct (i.e. the value satisfies to given validation),
+ function returns a tuple `{:ok, val}`. If not then `{:error, "msg"}`.
 
  Usage:
 
  Let say that you have a few input forms on your page, for instance: name,
- surname, password etc. Now you want to validate that the filled data are correct
+ surname, password etc. Now you want to validate whether the filled data are correct
  for each field. So you create somewhere inside your project a module
  [Validators](https://github.com/iodevs/validatex_example/blob/master/lib/server/validators.ex)
  which will be containing any of functions like bellow.