Fl4m3Ph03n1x
Usage of parenthesis in `spec`
Background
I few days ago I was checking some code from a co-worker and I was drawn to his usage of spec:
@spec hello(String.t(), String.t(), integer(), map()) :: any()
#function code here ....
We came together and he asked me why my usage of specs was different (I don’t use parenthesis):
# No parenthesis
@spec hello(String.t, String.t, integer, map) :: any
To which I responded:
"Well, the compiler will realize this is a function and will expand it automatically. So in reality, adding the extra parenthesis everywhere just adds more noise to your code without any real value and for functions with many arguments it makes the code harder to read. Also, since I am using the 80 characters per column limit, I find it that doing it this way is more compact while still delivering me the same amount of information. "
To which he replied:
Yeah but … in the official docs they use parenthesis everywhere. Why do they do it then?
Weerrmmmm… I have no idea.
Questions
- Do you use parenthesis in your
speccalls? - If so, why? (or why not?)
- Why does the documentation uses parenthesis every where?
- Are there any tangible benefits to using the parenthesis?
- What is the community standard on this matter ?
Trending in Questions
Other Trending Topics
Latest on Elixir Forum
Sponsor Spotlight
Phoenix, LiveView, multimedia pipelines, distributed systems. 400 engineers, Elixir since 2017. Available for hire.
Categories:
Sub Categories:
Forums
Popular Tags
- #ecto
- #liveview
- #troubleshooting
- #learning-elixir
- #deployment
- #library
- #erlang
- #testing
- #genserver
- #mix
- #absinthe
- #remote-other
- #otp
- #plug
- #how-to-question
- #macros
- #postgres
- #channels
- #elixirconf
- #exunit
- #discussion
- #code-sync
- #javascript
- #podcasts
- #onsite
- #dialyzer
- #docker
- #authentication
- #umbrella
- #full-time-contract
- #podcasts-by-brainlid
- #ecto-query
- #elixir-ls
- #phoenix_html
- #iex
- #blog-post
- #graphql
- #genstage
- #ai
- #elixirconf-us
- #websockets
- #supervisor
- #advent-of-code
- #distillery
- #processes
- #api
- #forms
- #metaprogramming
- #hex
- #performance
Our Sponsors
Build Elixir applications with speed and confidence.
Supporting innovation across the BEAM ecosystem.
We build reliable cloud platforms for business-critical systems.
Catch errors, track performance, monitor hosts and more.
Error tracking, logs, uptime, and Just Enough APM. Built for developers.
Bringing learning, work and compliance together since 1987.
Producing high quality Elixir screencasts since 2017.
The deployment platform built for Elixir: PaaS ease, VPS control.
The team behind Membrane, Popcorn, LiveDebugger. Available for hire.
Courses that'll move you from confusion to "Aha, now I get it!"
First 2 of 2 Posts
NobbZ
I use them in my
@specs for the very same reason I use them for zero-arity functions in my code. It removes ambiguity.If the parens are missing, I’ve always to check whether or not there is a
whenthat describes the item.lucaong
I noticed that the
mix formattask will add parentheses for all theModule.type()types likeString.t()orGenServer.server(), but does not for basic types likemaporinteger. So I tent to use the same convention in my code, but I don’t really know the reason. Possibly just consistency with the format of function calls, where the formatter also preferselems |> Enum.join()toelems |> Enum.jointo disambiguate between functions and special forms?Functionally they should be the same.