Skip to content

Commit

Permalink
[#129082833] fixing PR regarding comments
Browse files Browse the repository at this point in the history
  • Loading branch information
ferigis committed Sep 5, 2016
1 parent 523e6a1 commit b6faf9b
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 5 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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.
6 changes: 3 additions & 3 deletions src/sheldon_utils.erl
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand All @@ -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.
Expand Down

0 comments on commit b6faf9b

Please sign in to comment.