Update specs #157
Update specs #157
Conversation
| @@ -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 | |||
There was a problem hiding this comment.
no_return should be used when the function never returns (always raises, throws, endlessly loops, etc). Otherwise we'd need to annotate almost every function as they may e.g. raise an exception for invalid args, function clause, etc!
There was a problem hiding this comment.
Ah got it. That makes sense
| @@ -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() | |||
There was a problem hiding this comment.
I really don't think there's a use case for accepting an iodata, I'm happy to send a PR which removes the IO.iodata_to_binary call and thus this function just accepts a binary. And if there's a use case, we could always add it then. WDYT?
There was a problem hiding this comment.
Removing the IO.iodata_to_binary call makes sense to me. I can see by updating the postgrex extension it's not needed there. I can accept a PR to remove that 👍🏿
|
Thanks! |
No description provided.