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

RSP87
I’m working on a project that simulates the bumbl example in the programming phoenix book. It acts almost like an email client. We have a...
New
RemyXRenard
I’m seeing that a list inside a Kino.DataTable will be interpreted as a charlist, even if the Kino.configure() is set to charlists: :as_l...
New
nseaSeb
Hello, I know there is an approach for handling lists that allows for optimized traversal, but I can’t recall the specific method (somet...
New
velrest
So my question is quite simple and i have found no conclusive answer on forum, google or AI. Should we use :erlang.float for Integer to ...
New
samoloth
Hi, I’ve just set up an application with ash_authentication. There is only magic link strategy for now, so there is no confirmation add o...
New
FlyingNoodle
If a change or preparation module uses Ash.Changeset.get_argument/2 or Ash.Query.get_argument/2 (or any of the other get_argument functio...
New
ryanwinchester
apply_graft/2 doesn’t rewrite an add_many sub-workflow’s deps on an add step. Grafted jobs cancel with “upstream job was deleted” Version...
New

Other Trending Topics Top

mudasobwa
I am happy to introduce the very α version of the new programming language compiled to BEAM. Welcome Cure. It has literally three kille...
New
marciok
Hi there! We created Gust: A task orchestrator inspired by Airflow. For those who have never heard about Aiflow, it’s a Python-based wor...
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
Dmk
Xamal is a deployment tool for Elixir apps that deploys native releases to bare metal servers over SSH. It’s a port of GitHub - basecamp/...
New
Damirados
Hello everyone. After busy few months I am happy to announce v0.1.0 of Emerge & Solve. They are GUI (Emerge) and State management (S...
New
netoum
Corex is an accessible, unstyled UI component library for Phoenix that integrates Zag.js state machines using Vanilla JavaScript and Live...
New

We're in Beta

About us Mission Statement

Options

Thread Display Mode




Thread Preview

Skip Thread Previews