vrod
Hello! I am wondering if there is somewhere a “documentation cheetsheet”? I am looking at Writing documentation — Elixir v1.20.2 but I do not see a list of all available documentation attributes. I only see this sentence “such as @moduledoc, @typedoc, and @doc” but I am not knowing which options I can use or if other attributes are existing or which options they accept.
What should I use to documentation of @callback?
I am not seeing documentation for a function that implements callback. For exmaple:
defmodule Y do
@doc """
My documentation here
"""
@callback something() :: keyword()
end
defmodule X do
@behaviour Y
@impl true
def something() do
[a: "apple"]
end
end
However, my X module shows no functions in its documentation. This is not what I expect. ex_doc 0.24.2.
Thank you!
Trending in Questions
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
Documentation
While reading the Scoped Routes section, I noticed that the documentation currently refers to a problem without explainin...
New
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
Hi everyone,
I am toying with the idea of building a “match maker” for giving personal help to people that wants to start coding.
I sta...
New
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
I recently noticed that Elixir’s Logger defaults its primary log level to :debug when no :logger, :level application configuration is pre...
New
I’m new to elixir and just tried to install the elixirLS extension for VScode(ium) and it is throwing some errors that I would like help ...
New
Other Trending Topics
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
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
I am happy to introduce the very α version of the new programming language compiled to BEAM.
Welcome Cure.
It has literally three kille...
New
Hobbes is a low-level distributed database for the Elixir programming language.
Hobbes provides a simple, safe, and scalable storage lay...
New
Hi everyone!
The first release candidate for the Expert language server project is now available!
We’ve published a press release detai...
New
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
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
- #umbrella
- #full-time-contract
- #podcasts-by-brainlid
- #ai
- #ecto-query
- #elixirconf-us
- #blog-post
- #elixir-ls
- #phoenix_html
- #iex
- #graphql
- #genstage
- #websockets
- #supervisor
- #advent-of-code
- #distillery
- #processes
- #elixirconf-eu
- #api
- #forms
- #metaprogramming
- #hex










Showing Posts 1 to 8- Show Best Posts
- Show All (oldest first)
- Show All (newest first)
hauleth
Just
@docwill work.vrod
Thank you hauleth! Does the above work for you? I still see no documented functions in
Xhauleth
I would need to check, because it have been some time since I have implemented last behaviour that required documentation in Elixir (I implement most of behaviours in Erlang).
axelson
@behaviour is documented in the documentation for Module. The rest of the attributes are documented there as well.
eksperimental
You are right. It is a bug in ExDoc
eksperimental
@vrod, I already filed a report callbacks implementations are not listed in the module if `@impl true` · Issue #1352 · elixir-lang/ex_doc · GitHub
Will look into into a submit a PR tonight if I can.
eksperimental
Actually, this behaviour comes from Elixir.
vrod
Thank you! I read the bug report and I think I understand what Jose has said.