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.

Sign up for GitHub

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

Jump to bottom

Add names to arguments in functions' specs #71

Open

McSym28 wants to merge 1 commit into aj-foster:main from McSym28:spec_argument_names

Contributor

McSym28 commented Sep 11, 2024

Instead of:

  @spec get_an_album(String.t(), keyword) ::
          {:ok, Example.AlbumObject.t()} | {:error, GitHub.Error.t()}

we'll now have:

  @spec get_an_album(id :: String.t(), opts :: keyword) ::
          {:ok, Example.AlbumObject.t()} | {:error, GitHub.Error.t()}

Motivation (from Elixir documentation):

This is particularly useful in documentation as a way to differentiate multiple arguments of the same type (or multiple elements of the same type in a type definition)


          Add names to arguments in functions' specs

b408336

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet