Samuel-88

Samuel-88

Hello all,

I tried to find what is the correct ordering of public and private functions in a module but I could not find an official answer. Should private functions be grouped together with the public functions that use them or should they be kept alphabetically at the end of the module?

Thanks a lot for any help,

Showing Posts 1 to 3

al2o3cr

al2o3cr

FWIW, the language implementation prefers defps close to the caller:

https://github.com/elixir-lang/elixir/blob/main/lib/elixir/lib/map.ex

Samuel-88

Samuel-88 OP

Thanks for your answer.

I tried to find the solution in this doc but I couldn’t: Elixir Style Guide

Maybe there isn’t an official way to do this?

sbuttgereit

sbuttgereit

I speculate that might be because it’s hard to make an easily documented rule about it.

In many cases, we’re encouraged to write small declarative functions in lieu of in-function conditional/branching logic. This means you may well end up with a bunch of defp functions which serve the conditional needs of a single function and possibly no others. In such a case, keeping them close to where they’re called is very good and not difficult.

But other times you might have defp functions which are useful in a number of calling functions. What’s the rule for those? Keep close to the first caller? The last caller? Arguably these utility functions can be justified at the end of the module or even the beginning. I’ll tend to follow the rule that shared private functions like that go after the last caller and the last caller’s specific private functions; I like publicly callable functions to be more front and center so they go first… except for that first case of closely coupled definitions.

Anyway, I guess my point is that once you get away from that first case there are varying arguments for placement that can be circumstantial or simply preference based in a way that’s difficult to create an acceptable, pubic style-guide for.

— 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