From b6faf9bb6a699d94e0b51d6bfa51f5d20a1a4eea Mon Sep 17 00:00:00 2001 From: Felipe Ripoll Date: Mon, 5 Sep 2016 08:38:28 -0600 Subject: [PATCH] [#129082833] fixing PR regarding comments --- README.md | 6 ++++-- src/sheldon_utils.erl | 6 +++--- 2 files changed, 7 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index fb1f2f5..76761db 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,8 @@ And you can check all of our open-source projects at [inaka.github.io](http://in ### Erlang Shell -First of all Sheldon is an application and it needs to be started. You can use `sheldon:start/0`. +First of all Sheldon is an application and it needs to be started. You can use `rebar3 shell` to set the necessary paths, then use `sheldon:start/0` or `application:ensure_all_started(sheldon)` in order to start Sheldon but if you are using Sheldon as a dependency you can let OTP starts it from your_app.app file too. + Sheldon only has two main methods, `sheldon:check/1` and `sheldon:check/2`. As a user, you just need to use those. ```erlang @@ -65,4 +66,5 @@ ok ## Dependencies -- Erlang/OTP 19+ +- Erlang/OTP 19+ in order to use it. +- Erlang/OTP 19.0.2+ in order to test it. diff --git a/src/sheldon_utils.erl b/src/sheldon_utils.erl index 4eb0844..ec2faf4 100644 --- a/src/sheldon_utils.erl +++ b/src/sheldon_utils.erl @@ -31,8 +31,8 @@ %%% API %%%=================================================================== -%% @doc normalizes the iodata() escaping some chararcters and converting -%% to string(). +%% @doc normalizes the iodata() escaping some characters and converting +%% them to string(). -spec normalize(iodata()) -> string(). normalize(Word) -> CharToScape = [ "\n" @@ -56,7 +56,7 @@ normalize(Word) -> Escaped = escape_chars(Word, CharToScape), binary_to_list(Escaped). -%% @doc checks if iodata() can be a number +%% @doc checks if iodata() is a number -spec is_number(iodata()) -> boolean(). is_number(Word) -> re:run(Word, "^[0-9]*$") =/= nomatch.