TomHale
I’m trying to work around the following warning:
warning: redefining @doc attribute previously set at line 78.
Please remove the duplicate docs. If instead you want to override a previously defined @doc, attach the @doc attribute to a function head (the function signature not followed by any do-block). For example:
@doc """
new docs
"""
def get_futures_instruments(...)
I’ve tried to implement this advice, but can’t seem to work it out. What I’m doing is:
@doc """
Get all instruments, optionally filtered by underlying instrument(s)
*** This is the main doc string that I'm trying to override below. ***
"""
def get_futures_instruments(filter \\ nil)
@doc "Get all instruments whose names start with the given `filter_str`"
@spec get_futures_instruments(String.t() | nil) :: {:ok, list(map)} | error_response()
def get_futures_instruments(filter_str) when is_binary(filter_str) or is_nil(filter_str) do
...
end
@doc "Get all instruments whose names start with any of those given in `filter_list`"
@spec get_futures_instruments(list(String.t())) :: {:ok, list(map)} | error_response()
def get_futures_instruments(filter_list) when is_list(filter_list) do
...
end
Trending in Questions
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
I’m very new to Elixir, so sorry if this is a silly question:
I am wondering what happens to the mailbox of a process when the machine i...
New
How do I tell Hologram not to escape HTML when substituting into templates?
{Textile.render(@product.long_description)}
escapes the HTM...
New
Background
When trying to execute mix release on a Windows 11 machine for a Phoenix project I get the following error:
* assembling mark...
New
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
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
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
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
Hi everyone :waving_hand:
I wanted to share something I’ve been building — NowBlind, a random chat app designed to help people discover ...
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
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 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
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
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
- #code-sync
- #discussion
- #podcasts
- #javascript
- #onsite
- #dialyzer
- #docker
- #authentication
- #ai
- #umbrella
- #elixirconf-us
- #full-time-contract
- #podcasts-by-brainlid
- #blog-post
- #ecto-query
- #elixir-ls
- #phoenix_html
- #iex
- #graphql
- #genstage
- #websockets
- #supervisor
- #advent-of-code
- #distillery
- #elixirconf-eu
- #processes
- #security
- #api
- #forms
- #performance










Showing Posts 1 to 3- Show Best Posts
- Show All (oldest first)
- Show All (newest first)
APB9785
I think what the warning is getting at, is that all your docs should be above
Checking the docs for the docs (Writing Documentation — Elixir v1.12.3), it says:
It seems like what you’re trying to do in the OP goes against this rule.
TomHale
In what case then could I override a previously defined @doc? It doesn’t make sense to me to override a doc string by having two in a row.
Nicd
Perhaps if a macro has written a
@docfor you, then you might end up with two@doc.