aethereus

aethereus

An irrelevant question, there are function names like Integer.is_odd, and there are function names like Enum.empty?, why the two different naming styles?

Showing Posts 1 to 4

mjadczak

mjadczak

Traditionally, Erlang uses is_xxx for functions which return a boolean value. In particular, functions which can be used in guards, of which many are indeed is_xxx functions, were taken wholesale into Elixir from Erlang. Currently, in Elixir, the is_xxx format serves as an indicator that a function / method can be used inside a guard. Since Integer.is_odd/1 is a macro which can be placed into a guard, it also follows this convention. Most other Elixir functions which return a boolean value, such as Enum.empty?/1 cannot be placed in guards, and follow the normal Elixir xxx? naming convention.

aethereus

aethereus OP

But non-boolean guard-friendly functions such as div and rem do not have such indicator, why should boolean functions be a special case? For fresh Elixir programmers, remembering different naming styles can be a burden, so why not use xxx? style exclusively?

christhekeele

christhekeele

Because not having a way to recognize the special-case guard-enabled functions would be more confusing to new-comers.

Guards are used much, much more often than they are created—they are possibly typed out more than any other function or macro, if and def included. This is especially true of the is_ type-check guards since they are the only way to switch on type information, in or outside function heads. So you will rapidly become fluent with this special casing.

We want new-comers to learn fast and well the fact that you can’t throw just any predicate function into a guard. Accepting the cognitive burden of remembering which functions are allowed in guards is far more important than the burden of remembering to use a different naming style when writing them, and if they were named identically it would be much harder to memorize which is which for the first time.

Additionally, this naming difference helps visibility and discoverability: we want these special cases to stand out in documentation, we want people like you to notice the discrepancy and take note of it like you have here, instead of frustratedly filing bug reports about how only some predicates seem to work in guards. :smile: So I think it has proved an effective decision.

michalmuskala

michalmuskala

As a side note, this convention is explained in the Naming Conventions doc page.

11
Post #4
— 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
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
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
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
brecabral
Documentation While reading the Scoped Routes section, I noticed that the documentation currently refers to a problem without explainin...
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

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
netoum
Corex is an accessible, unstyled UI component library for Phoenix that integrates Zag.js state machines using Vanilla JavaScript and Live...
New
webofbits
With AI doing more of the implementation work, I’ve been wondering how much coding I should deliberately keep doing myself. My main conc...
#ai
New

We're in Beta

About us Mission Statement

Options

Thread Display Mode




Thread Preview

Skip Thread Previews