Skip to content

Commit

Permalink
Add module documentation where it was missing
Browse files Browse the repository at this point in the history
  • Loading branch information
duijf committed Aug 15, 2015
1 parent b9adb74 commit 8134941
Show file tree
Hide file tree
Showing 5 changed files with 35 additions and 0 deletions.
7 changes: 7 additions & 0 deletions lib/crutches/enum.ex
Original file line number Diff line number Diff line change
@@ -1,4 +1,11 @@
defmodule Crutches.Enum do
@moduledoc ~s"""
Convenience functions for enums.
This module provides several convenience functions operating on enums.
Simply call any function (with any options if applicable) to make use of it.
"""

@doc ~S"""
Returns a copy of the `collection` without the specified `elements`.
Expand Down
7 changes: 7 additions & 0 deletions lib/crutches/integer.ex
Original file line number Diff line number Diff line change
@@ -1,4 +1,11 @@
defmodule Crutches.Integer do
@moduledoc ~s"""
Convenience functions for integers.
This module provides several convenience functions operating on integers.
Simply call any function (with any options if applicable) to make use of it.
"""

@doc ~S"""
Return _just_ the ordinal of a number ("st", "nd", "rd", "th")
Expand Down
7 changes: 7 additions & 0 deletions lib/crutches/list.ex
Original file line number Diff line number Diff line change
@@ -1,4 +1,11 @@
defmodule Crutches.List do
@moduledoc ~s"""
Convenience functions for lists.
This module provides several convenience functions operating on lists.
Simply call any function (with any options if applicable) to make use of it.
"""

@doc ~S"""
Returns the tail of the `collection` from `position`.
Expand Down
7 changes: 7 additions & 0 deletions lib/crutches/map.ex
Original file line number Diff line number Diff line change
@@ -1,4 +1,11 @@
defmodule Crutches.Map do
@moduledoc ~s"""
Convenience functions for maps.
This module provides several convenience functions operating on maps.
Simply call any function (with any options if applicable) to make use of it.
"""

@doc """
Travel through a map by specifying a path, JSON-style.
First parameter is the map, second parameter is the path (either as a list or a string).
Expand Down
7 changes: 7 additions & 0 deletions lib/crutches/string.ex
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,13 @@ defmodule Crutches.String do
strip: 1
]

@moduledoc ~s"""
Convenience functions for strings.
This module provides several convenience functions operating on strings.
Simply call any function (with any options if applicable) to make use of it.
"""

@doc ~S"""
Converts a `string` to `snake_case`.
Expand Down

0 comments on commit 8134941

Please sign in to comment.