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
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,
I know there is an approach for handling lists that allows for optimized traversal, but I can’t recall the specific method (somet...
New
Documentation
While reading the Scoped Routes section, I noticed that the documentation currently refers to a problem without explainin...
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
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
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
Hi everyone!
The first release candidate for the Expert language server project is now available!
We’ve published a press release detai...
New
Beam Bots (or just BB for short) is a framework for building fault-tolerant robotics applications in Elixir using familiar OTP patterns. ...
New
Xamal is a deployment tool for Elixir apps that deploys native releases to bare metal servers over SSH. It’s a port of GitHub - basecamp/...
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
- #ecto-query
- #elixirconf-us
- #ai
- #blog-post
- #elixir-ls
- #phoenix_html
- #iex
- #graphql
- #genstage
- #websockets
- #supervisor
- #advent-of-code
- #distillery
- #processes
- #api
- #forms
- #metaprogramming
- #hex
- #security










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.