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 ![]()
Trending in Questions
I’m aware of 2 such projects, are there others?
git: GitHub - team-alembic/realworld: A fullstack Phoenix LiveView application with back...
New
I having some trouble figuring out if I have set myself too strict of standards for my production server. Currently I can handle 75% of r...
New
Hi everyone.
My team and I have been working on a fairly modest app based around video streaming and chat, but we’ve landed a customer t...
New
I really like the adapter patterns that ecto, nebulex, waffle, etc. use and would love find something similar for a key management servic...
New
Hello folks!
So at work, we are seeing some situations where we have to define some “fixed” strings that are used across the codebase in...
New
How Can I Optimise Compile Time Dependencies
I have been building an elixir application for about 2 years now. Many modules and files ha...
New
Hi,
we run different LLM models across a cluster, with each node loading a configurable subset. Model-specific queues let nodes consume ...
New
Other Trending Topics
Hey. Is there anyone here who creates agents in their apps? Not talking about using agents, but creating them. I’m finding it pretty diff...
New
I fully migrated to my own harness from Anthropic/Gemini and I think it’s time to share it. Welcome DSH, the DeepSeek Harness, fully writ...
New
Beam Bots (or just BB for short) is a framework for building fault-tolerant robotics applications in Elixir using familiar OTP patterns. ...
New
There has been a thread to discuss the Stack Overflow Developer Survey on this forum every year since 2018, so here’s yet another one for...
New
I love Elixir. It’s one of 2 programming languages I’ve ever fallen in love with.
But I don’t use it anymore.
Serverless was the promis...
New
Emily is an Elixir library that runs Nx computations on Apple’s MLX. Install it as the default Nx backend and Nx, defn, Axon, Nx.Serving,...
New
Categories:
Sub Categories:
Forums
Popular Tags
- #ecto
- #liveview
- #troubleshooting
- #learning-elixir
- #library
- #deployment
- #erlang
- #testing
- #genserver
- #mix
- #absinthe
- #remote-other
- #otp
- #plug
- #how-to-question
- #macros
- #postgres
- #elixirconf
- #channels
- #exunit
- #discussion
- #code-sync
- #podcasts
- #javascript
- #onsite
- #dialyzer
- #docker
- #authentication
- #ai
- #umbrella
- #full-time-contract
- #podcasts-by-brainlid
- #ecto-query
- #blog-post
- #elixirconf-us
- #elixir-ls
- #phoenix_html
- #iex
- #graphql
- #genstage
- #websockets
- #supervisor
- #advent-of-code
- #distillery
- #processes
- #elixirconf-eu
- #api
- #forms
- #security
- #performance










Showing Posts 1 to 5- Show Best Posts
- Show All (oldest first)
- Show All (newest first)
Marcus
I assume that
@docjust accepts a string and replaces anything else with nil.Maybe you want
hello2looks like:I also assume that the line number means the position in the file not the position in the definition.
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:and
Eiji
Unfortunately it would be possible not sooner than in
Elixirversion2.x, see: Provide an API to access documentation metadata at compile time · Issue #8095 · elixir-lang/elixir · GitHubLostKobrakai
Yeah
@doc deprecated: …is used for soft deprecation@deprecatedis hard deprecation integrated with the compiler.arjan
Thanks, very helpful link!