Fl4m3Ph03n1x

Fl4m3Ph03n1x

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

  1. Do you use parenthesis in your spec calls?
  2. If so, why? (or why not?)
  3. Why does the documentation uses parenthesis every where?
  4. Are there any tangible benefits to using the parenthesis?
  5. What is the community standard on this matter ?

Showing Posts 1 to 2

NobbZ

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 when that describes the item.

lucaong

lucaong

I noticed that the mix format task will add parentheses for all the Module.type() types like String.t() or GenServer.server(), but does not for basic types like map or integer. 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 prefers elems |> Enum.join() to elems |> Enum.join to disambiguate between functions and special forms?

Functionally they should be the same.

— All posts loaded —

Where Next? Top

Trending in Questions Top

katta
I having some trouble figuring out if I have set myself too strict of standards for my production server. Currently I can handle 75% of r...
New
peck
Hi everyone. My team and I have been working on a fairly modest app based around video streaming and chat, but we’ve landed a customer t...
New
achenet
Hello, I’m trying to build a basic Phoenix web-app, and I’d like to use Tailwind. However, when I launch mix phx.server, I get an error...
New
bradley
I really like the adapter patterns that ecto, nebulex, waffle, etc. use and would love find something similar for a key management servic...
New
unaware8150
Hello folks! So at work, we are seeing some situations where we have to define some “fixed” strings that are used across the codebase in...
New
Cxx-mlr
I’m working on a small exercise involving update_in/3, and I came up with this solution: data = %{ name: "Periodic Table", category:...
New
Alvinkariuki
How Can I Optimise Compile Time Dependencies I have been building an elixir application for about 2 years now. Many modules and files ha...
New

Other Trending Topics Top

GenericJam
Edit: 2026 May 15 - This post is archived. Mob is alive!! Main docs: mob v0.7.11 — Documentation A bit of explanation for the slightly c...
New
budgie
A little off-topic, but I feel like people here have a good head on their shoulders. I used to be quite good at making software. Was luc...
New
KristerV
Hey. Is there anyone here who creates agents in their apps? Not talking about using agents, but creating them. I’m finding it pretty diff...
New
mudasobwa
I fully migrated to my own harness from Anthropic/Gemini and I think it’s time to share it. Welcome DSH, the DeepSeek Harness, fully writ...
New
jimsynz
Beam Bots (or just BB for short) is a framework for building fault-tolerant robotics applications in Elixir using familiar OTP patterns. ...
New
juhalehtonen
There has been a thread to discuss the Stack Overflow Developer Survey on this forum every year since 2018, so here’s yet another one for...
New

We're in Beta

About us Mission Statement

Options

Thread Display Mode




Thread Preview

Skip Thread Previews