diff --git a/lib/crutches/enum.ex b/lib/crutches/enum.ex index 8335d1e..ba5e2c6 100644 --- a/lib/crutches/enum.ex +++ b/lib/crutches/enum.ex @@ -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`. diff --git a/lib/crutches/integer.ex b/lib/crutches/integer.ex index 393bd85..945745a 100644 --- a/lib/crutches/integer.ex +++ b/lib/crutches/integer.ex @@ -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") diff --git a/lib/crutches/list.ex b/lib/crutches/list.ex index 2827302..a4facde 100644 --- a/lib/crutches/list.ex +++ b/lib/crutches/list.ex @@ -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`. diff --git a/lib/crutches/map.ex b/lib/crutches/map.ex index 7686a43..cc9e79b 100644 --- a/lib/crutches/map.ex +++ b/lib/crutches/map.ex @@ -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). diff --git a/lib/crutches/string.ex b/lib/crutches/string.ex index 2b0479a..a1add52 100644 --- a/lib/crutches/string.ex +++ b/lib/crutches/string.ex @@ -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`.