arjan

arjan

I am trying to hook into the @doc deprecated: "message" annotation using __on_definition__.

defmodule ExampleCompiler do
  def __on_definition__(env, _, fun, _, _, _) do
    doc = Module.get_attribute(env.module, :doc)
    IO.inspect(doc, label: fun)
  end
end

defmodule DemoModule do
  @on_definition ExampleCompiler

  @doc "hello"
  def hello() do
  end

  @doc deprecated: "hello2"
  def hello2() do
  end
end

Output of compilation:

hello: {11, "hello"}
hello2: nil

So, for some reason in the on_definition hook of the hello2 function, the module @doc attribute is empty whereas a keyword list [deprecated: ".."] would be expected. There seems to be something special in the compiler regarding the @doc module attribute, because when I change it to @doc2 it works as expected.

Also note the line number annotation in the first definition, this is also inconsistent with other module attributes. I have already been loking in the Module docs but I don’t see anything that tells me that @doc is special. Help appreciated :slight_smile:

Showing Posts 1 to 5

Marcus

Marcus

I assume that @doc just accepts a string and replaces anything else with nil.
Maybe you want hello2 looks like:

  @doc "hello2`
  @deprecated "use hello instead"
  def hello2() do
  end

I also assume that the line number means the position in the file not the position in the definition.

dr_theuns

dr_theuns

I would expect the keyword list approach to work because it’s also used this way in the stdlib. For example, from docs_test.exs:

@doc "Callback doc"
@doc since: "1.2.3", color: :red, deprecated: "use baz/2 instead"
@doc color: :blue, stable: true
@callback foo(any) :: any

and

@doc deprecated: "Use Logger.delete_process_level(pid) instead"
Eiji

Eiji

Unfortunately it would be possible not sooner than in Elixir version 2.x, see: Provide an API to access documentation metadata at compile time · Issue #8095 · elixir-lang/elixir · GitHub

LostKobrakai

LostKobrakai

Yeah @doc deprecated: … is used for soft deprecation @deprecated is hard deprecation integrated with the compiler.

arjan

arjan OP

Thanks, very helpful link!

— 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
brecabral
Documentation While reading the Scoped Routes section, I noticed that the documentation currently refers to a problem without explainin...
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
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
asweet-confluent
I recently noticed that Elixir’s Logger defaults its primary log level to :debug when no :logger, :level application configuration is pre...
New

Other Trending Topics Top

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
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
mhanberg
Hi everyone! The first release candidate for the Expert language server project is now available! We’ve published a press release detai...
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

Latest on Elixir Forum

We're in Beta

About us Mission Statement

Options

Thread Display Mode




Thread Preview

Skip Thread Previews