Improve docs and add some types

Author: harrygr

README.md

@@ -6,13 +6,12 @@ Landmark is designed to work with structs provided by the [Geo][geo] library
 
 ## Installation
 
-If [available in Hex](https://hex.pm/docs/publish), the package can be installed
-by adding `landmark` to your list of dependencies in `mix.exs`:
+Add `landmark` to your list of dependencies in `mix.exs`:
 
 ```elixir
 def deps do
   [
-    {:landmark, "~> 0.1.0"}
+    {:landmark, "~> 0.3.0"}
   ]
 end
 ```

lib/landmark.ex

@@ -1,2 +1,5 @@
 defmodule Landmark do
+  @moduledoc """
+  Landmark is a geospatial analysis library.
+  """
 end

lib/landmark/helpers.ex

@@ -1,12 +1,21 @@
 defmodule Landmark.Helpers do
   @earth_radius 6_371_008.8
 
+  @type length_unit() :: :radians | :meters | :metres | :kilometers | :kilometres
+
   @doc """
   Convert a distance measurement (assuming a spherical Earth) from radians to a more friendly unit.
+
+  ## Examples
+
+      iex> Landmark.Helpers.radians_to_length(1, :kilometers)
+      6371.0088
   """
+  @spec radians_to_length(number(), length_unit()) :: number()
   def radians_to_length(radians, unit)
   def radians_to_length(radians, :radians), do: radians
   def radians_to_length(radians, :meters), do: radians * @earth_radius
-  def radians_to_length(radians, :metres), do: radians * @earth_radius
+  def radians_to_length(radians, :metres), do: radians_to_length(radians, :meters)
   def radians_to_length(radians, :kilometers), do: radians * @earth_radius / 1000
+  def radians_to_length(radians, :kilometres), do: radians_to_length(radians, :kilometers)
 end

lib/landmark/measurement.ex

@@ -77,8 +77,17 @@ defmodule Landmark.Measurement do
   end
 
   @doc """
-  Computes the bounding box for an object
+  Computes the bounding box for an object.
+
+  ## Examples
+      iex> Landmark.Measurement.bbox(%Geo.LineString{coordinates: [{1, 2}, {4, 6}]})
+      {1, 2, 4, 6}
+
+      iex> Landmark.Measurement.bbox(%Geo.LineString{coordinates: []})
+      nil
   """
+  @spec bbox(Geo.geometry() | list({number(), number()})) ::
+          {number(), number(), number(), number()} | nil
   def bbox(object)
 
   def bbox(%Geo.Point{coordinates: coordinates}), do: bbox([coordinates])

mix.exs

@@ -4,12 +4,15 @@ defmodule Landmark.MixProject do
   def project do
     [
       app: :landmark,
-      version: "0.3.0",
+      version: "0.4.0",
       elixir: "~> 1.14",
       start_permanent: Mix.env() == :prod,
       deps: deps(),
       description: description(),
-      package: package()
+      package: package(),
+      name: "Landmark",
+      source_url: "https://github.com/harrygr/landmark",
+      docs: &docs/0
     ]
   end
 
@@ -43,4 +46,10 @@ defmodule Landmark.MixProject do
       links: %{"GitHub" => "https://github.com/harrygr/landmark"}
     ]
   end
+
+  defp docs do
+    [
+      extras: ["README.md"]
+    ]
+  end
 end

test/helpers_test.exs

@@ -0,0 +1,5 @@
+defmodule HelpersTest do
+  use ExUnit.Case
+
+  doctest Landmark.Helpers
+end