Skip to content

Commit

Permalink
Minor clarifications to documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
rgrempel committed Sep 11, 2015
1 parent 7464bf4 commit dfb61c6
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 4 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ uriDecoded for you.
## Setting Cookies

If you don't need to provide special options, then you can just create
a `set` task by supplying the key and value.
a `set` task by supplying the key (first parameter) and value (second parameter).

```elm
set : String -> String -> Task x ()
Expand Down
7 changes: 4 additions & 3 deletions src/Cookies.elm
Original file line number Diff line number Diff line change
Expand Up @@ -62,10 +62,10 @@ cookieString2Dict =
List.foldl addCookieToDict Dict.empty << split ";"


{-| A task which will set a cookie using the provided key and value.
{-| A task which will set a cookie using the provided key (first parameter)
and value (second parameter).
The key and value will both be uriEncoded.
-}
set : String -> String -> Task x ()
set = setWithOptions defaultOptions
Expand Down Expand Up @@ -99,7 +99,8 @@ defaultOptions =
}


{-| A task which will set a cookie using the provided options, key and value.
{-| A task which will set a cookie using the provided options, key (second
parameter), and value (third parameter).
The key and value will be uriEncoded, as well as the path and domain options (if provided).
-}
Expand Down

0 comments on commit dfb61c6

Please sign in to comment.