CODEWITHSUNDEEP
erlangdialyzertypespec
Max Heiber
Max Heiber

Reputation: 15502

Why do type specs in OTP repeat parameter names?

In type specs for the Erlang standard library, there are almost never any types in the spec until the when clause. For example, the spec for lists:member/2 is like this:

-spec member(Elem, List) -> boolean() when
      Elem :: T,
      List :: [T],
      T :: term().

instead of:

-spec member(Elem :: T, List :: [T]) -> boolean() when
      T :: term().

Is there a reason for this? Are these two styles equivalent from the dialyzer's point of view?

Upvotes: 1

Views: 88

Answers (1)

Lukas
Lukas

Reputation: 5327

It is done that way because the documentation that is generated from the specs looks better if done like that.

Upvotes: 3

Related Questions