Merge pull request #157 from wojtekmach/wm-specs

Update specs

lib/geo/json.ex

@@ -30,7 +30,7 @@ defmodule Geo.JSON do
   @doc """
   Takes a map representing GeoJSON and returns a Geometry.
   """
-  @spec decode!(map()) :: Geo.geometry() | no_return
+  @spec decode!(map()) :: Geo.geometry()
   defdelegate decode!(geo_json), to: Decoder
 
   @doc """
@@ -42,7 +42,7 @@ defmodule Geo.JSON do
   @doc """
   Takes a Geometry and returns a map representing the GeoJSON.
   """
-  @spec encode!(Geo.geometry()) :: map() | no_return
+  @spec encode!(Geo.geometry()) :: map()
   defdelegate encode!(geom), to: Encoder
   defdelegate encode!(geom, opts), to: Encoder
 

lib/geo/json/decoder.ex

@@ -31,7 +31,7 @@ defmodule Geo.JSON.Decoder do
   @doc """
   Takes a map representing GeoJSON and returns a Geometry.
   """
-  @spec decode!(map()) :: Geo.geometry() | no_return
+  @spec decode!(map()) :: Geo.geometry()
   def decode!(geo_json) do
     cond do
       Map.has_key?(geo_json, "geometries") ->

lib/geo/wkb.ex

@@ -21,14 +21,15 @@ defmodule Geo.WKB do
   Takes a Geometry and returns a WKB string. The endian decides
   what the byte order will be.
   """
-  @spec encode!(Geo.geometry(), Geo.endian()) :: binary | no_return
+  @spec encode!(Geo.geometry(), Geo.endian()) :: binary
   def encode!(geom, endian \\ :xdr) do
     geom |> Encoder.encode!(endian) |> IO.iodata_to_binary() |> Base.encode16()
   end
 
   @doc """
-  Takes a Geometry and returns a WKB string. The endian decides
-  what the byte order will be.
+  Takes a Geometry and returns a WKB string.
+
+  The endian decides what the byte order will be.
   """
   @spec encode(binary, Geo.endian()) :: {:ok, binary} | {:error, Exception.t()}
   def encode(geom, endian \\ :xdr) do
@@ -39,10 +40,11 @@ defmodule Geo.WKB do
   end
 
   @doc """
-  Takes a Geometry and returns a WKB as iodata. The endian decides
-  what the byte order will be.
+  Takes a Geometry and returns a WKB as iodata.
+
+  The endian decides what the byte order will be.
   """
-  @spec encode_to_iodata(Geo.geometry(), Geo.endian()) :: iodata() | no_return
+  @spec encode_to_iodata(Geo.geometry(), Geo.endian()) :: iodata()
   def encode_to_iodata(geom, endian \\ :xdr) do
     Encoder.encode!(geom, endian)
   end
@@ -79,7 +81,7 @@ defmodule Geo.WKB do
   @doc """
   Takes a WKB string and returns a Geometry.
   """
-  @spec decode!(binary | iodata()) :: Geo.geometry() | no_return
+  @spec decode!(iodata()) :: Geo.geometry()
   def decode!(wkb)
 
   def decode!("00" <> _ = wkb) do

lib/geo/wkt.ex

@@ -38,6 +38,6 @@ defmodule Geo.WKT do
   @doc """
   Takes a WKT string and returns a Geo.geometry struct or list of Geo.geometry.
   """
-  @spec decode!(binary) :: Geo.geometry() | no_return
+  @spec decode!(binary) :: Geo.geometry()
   defdelegate decode!(wkt), to: Decoder
 end

lib/geo/wkt/decoder.ex

@@ -32,7 +32,7 @@ defmodule Geo.WKT.Decoder do
   @doc """
   Takes a WKT string and returns a Geo.geometry struct or list of Geo.geometry.
   """
-  @spec decode!(binary) :: Geo.geometry() | no_return
+  @spec decode!(binary) :: Geo.geometry()
   def decode!(wkt) do
     wkt_split = String.split(wkt, ";")