jarlah

jarlah

Hi

I’m wondering what is the best practice for type specs. Keep them all in one place or keep them close to their usage?

I remember seeing somewhere, an example, where the types was defined on top of the module. For me it makes sense to keep the type specs away from the functions, because its not the thing i need to know. I can just hover and get the type of the method if i want to.

/J

Showing Posts 1 to 4

slouchpie

slouchpie

I put specs between a function’s doc and its declaration. “Hover for spec” is editor/IDE-dependant. I imagine there is no objective best practice. I like to have the spec close to the function, espectially when reading new code. This is also how I see it in all codebases/libraries that I can remember.

@doc """
"""
@spec like_this() :: return_type()
def like_this do
 # ...
end
moogle19

moogle19

Yes, like @slouchpie I would keep the function spec (@spec, @callback, @macrocallback) close to the function and put the custom type specs (@type, @typep, @opaque) at the top of my module, e.g.

defmodule Foo.Bar do
  use Baz

  @type foo_result :: {atom, String.t()}
  @typep private_type :: {atom, atom, atom}

  ...

  @doc """
  Random function
  """
  @spec random_function(integer) :: foo_result
  def random_function(input) do
    ...
  end
end
jarlah

jarlah OP

Sounds like a good plan.

wmnnd

wmnnd

The practice that @moogle19 has suggested is also what’s practiced in the Elixir standard library, e.g. here: elixir/lib/elixir/lib/enum.ex at main · elixir-lang/elixir · GitHub

— All posts loaded —

Where Next? Top

Trending in Discussions Top

AstonJ
As the title says, please share what you’ve been up to with Elixir. Whether that’s been learning it, looking into it, making stuff with i...
2977 94592 917
New
cblavier
Hey there, It’s been more than a year since we started using LiveView as our main UI library and building a whole library of UI componen...
New
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
heathen
Quite interesting article Google brought me. Didn’t find any mentions about it here. What do you think in general? Would you use togethe...
New
mhanberg
Hi everyone! The first release candidate for the Expert language server project is now available! We’ve published a press release detai...
New
axelson
Hi there! :wave: @frigidcode and I (but mostly him) have been running an Elixir Book club, we’re almost done with Designing Elixir Syste...
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

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
JesseHerrick
Hey, I’m Jesse and I’m the main contributor behind Dexter, a full-featured, lightning-fast Elixir LSP optimized for large codebases. It s...
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
georgeguimaraes
Just published claude-code-elixir, a plugin marketplace for Claude Code with Elixir support. These are the plugins I’ve been using for my...
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

We're in Beta

About us Mission Statement

Options

Thread Display Mode




Thread Preview

Skip Thread Previews