Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

decode!/2 has invalid type signature for options #199

Open
DaniruKun opened this issue Oct 9, 2021 · 0 comments · May be fixed by #202
Open

decode!/2 has invalid type signature for options #199

DaniruKun opened this issue Oct 9, 2021 · 0 comments · May be fixed by #202

Comments

@DaniruKun
Copy link

DaniruKun commented Oct 9, 2021

Description

The usage example of decode!/2 with the as option does not match the actual type spec, causing dialyzer to complain.

Steps to reproduce

  1. Create 2 functions in an Elixir module:
  def example do
	body = "some data"
	Poison.decode!(body, as: [%Video{}])
  end

  def example2 do
	body = "some data"
	Poison.decode!(body, %{as: [%Video{}]})
  end
  1. Run dialyzer, it will fail with:
Function example/0 has no local return.
________________________________________________________________________________
lib/api/videos.ex:68:call
The function call will not succeed.


breaks the contract
(iodata(), Poison.Decoder.options()) :: Poison.Decoder.t() | no_return()

As you can see, example2 is valid, while example is not.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant