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
Hey guys,
I’ve got a huge CSV ( around 10 GB ) that needs to be processed hourly
Do you guys have any suggestions what is the best prac...
New
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
Hello!
Could someone please give me a help/sample code, how to delete a file from s3 using waffle/waffle_ecto from Phoenix app.
I creat...
New
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
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
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
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
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 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
Beam Bots (or just BB for short) is a framework for building fault-tolerant robotics applications in Elixir using familiar OTP patterns. ...
New
Hello everyone. After busy few months I am happy to announce v0.1.0 of Emerge & Solve.
They are GUI (Emerge) and State management (S...
New
Corex is an accessible, unstyled UI component library for Phoenix that integrates Zag.js state machines using Vanilla JavaScript and Live...
New
Categories:
Sub Categories:
Forums
Popular Tags
- #ecto
- #liveview
- #troubleshooting
- #learning-elixir
- #deployment
- #library
- #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
- #ecto-query
- #blog-post
- #elixirconf-us
- #elixir-ls
- #ai
- #phoenix_html
- #iex
- #graphql
- #genstage
- #websockets
- #supervisor
- #advent-of-code
- #distillery
- #processes
- #api
- #forms
- #hex
- #security
- #metaprogramming










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.