vrod

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!

Showing Posts 1 to 8

vrod

vrod OP

Thank you hauleth! Does the above work for you? I still see no documented functions in X

hauleth

hauleth

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

axelson

Scenic Core Team

@behaviour is documented in the documentation for Module. The rest of the attributes are documented there as well.

eksperimental

eksperimental

You are right. It is a bug in ExDoc

eksperimental

eksperimental

eksperimental

eksperimental

Actually, this behaviour comes from Elixir.

vrod

vrod OP

Thank you! I read the bug report and I think I understand what Jose has said.

— All posts loaded —

Where Next? Top

Trending in Questions Top

stjefim
Hello! Suppose you are building workflow (order / task / payment) processing system with the following requirements: Each workflow con...
New
itzmidinesh
Hi all, I’m working on a Phoenix project where I need to make external HTTP requests and I’m trying to choose between Req and HTTPoison....
New
pragdave
How do I tell Hologram not to escape HTML when substituting into templates? {Textile.render(@product.long_description)} escapes the HTM...
New
leoschweizer
Hi, we run different LLM models across a cluster, with each node loading a configurable subset. Model-specific queues let nodes consume ...
New
rlipscombe
I’d like to create a file with 600 permissions (rw-------), but there’s a race condition if I create it and then change the permissions. ...
New
saleyn
Is there a way to import record definitions in the iex shell for pretty printing (similar to the rr command in the erl shell)? This woul...
New
rlipscombe
When I use Mix.install with a git dependency, using git@github.com:... how do I change the SSH identity used? I’ve got two Github accoun...
New

Other Trending Topics Top

dominicletz
Hey there, I haven’t seen a list of useful Elixir specific skills for the popular AI tools yet so I’m starting one here with my first. ...
New
raa-ziq
Hi everyone :waving_hand: I wanted to share something I’ve been building — NowBlind, a random chat app designed to help people discover ...
New
mudasobwa
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
KristerV
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
OndrejValenta
(I just needed to vent somewhere and LinkedIn is full of hope, or hype, I’m not sure which exactly) AI dream has many faces, but general...
New
kip
Localize is the next generation localisation library for Elixir. Think of it as ex_cldr version 3.0. The first version will be released ...
New

We're in Beta

About us Mission Statement

Options

Thread Display Mode




Thread Preview

Skip Thread Previews