Skip to content

Commit

Permalink
tidy up @doc comments for generating docs using ex_docs #4
Browse files Browse the repository at this point in the history
  • Loading branch information
nelsonic committed Oct 14, 2019
1 parent f69d551 commit 2966d1a
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions lib/quotes.ex
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@ defmodule Quotes do
"""

@doc """
parse_json returns a list of maps with quotes in the following form:
`parse_json` returns a list of maps containing quotes. <br />
The format returned is:
```elixir
[
%{
Expand All @@ -31,7 +33,8 @@ defmodule Quotes do
end

@doc """
random returns a random quote.
`random` returns a random quote. <br />
e.g:
```elixir
%{
Expand Down

0 comments on commit 2966d1a

Please sign in to comment.