TomHale

TomHale

How do I overload @doc strings?

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

Most Liked

APB9785

APB9785

Creator of ECSx

I think what the warning is getting at, is that all your docs should be above

def get_futures_instruments(filter \\ nil)

Checking the docs for the docs (Writing Documentation — Elixir v1.12.3), it says:

  • Place documentation before the first clause of multi-clause functions. Documentation is always per function and arity and not per clause.

It seems like what you’re trying to do in the OP goes against this rule.

Nicd

Nicd

Perhaps if a macro has written a @doc for you, then you might end up with two @doc.

Where Next?

Popular in Questions Top

vegabook
I’m brand new to Phoenix and I have stripped one of the demo applications to the bone. I just want to get an svg up on the screen. Here i...
New
hariharasudhan94
lets say i have a sample like a = 20; b = 10; if (a > b) do {:ok, "a"} end if (a < b) do {:ok, b} end if (a == b) do {:ok, "equa...
New
Emily
I have VueJS GUIs with the project generated using Webpack. I have Elixir modules that will need to be used by the VueJS GUIs. I forese...
New
ovidiubadita
Hey all, I discovered Elixir and I love it. I always wanted to learn a functional programming and I intended to go for Haskell, but afte...
New
gshaw
What is the idiomatic way of matching for not nil in Elixir? E.g., First way: defp halt_if_not_signed_in(conn, signed_in_account) when...
New
jerry
Good day to you all. I have been struggling to get a query involving like and ilike to work. Can anyone assist me on this, please? pro...
New
senggen
Erlang/OTP 25 [erts-13.2.2] [source] [64-bit] [smp:8:8] [ds:8:8:10] [async-threads:1] 15:22:35.803 [error] gen_event {lager_file_backend...
New

Other popular topics Top

minhajuddin
I have seen a lot of code which picks the first element from a list using Enum.at(0) instead of List.first. Is there a reason why people ...
New
stefanchrobot
What’s the safe way to decode a JSON string into a struct? I want to avoid calling String.to_atom. Jason.decode can give me a map with st...
New
gshaw
What is the idiomatic way of matching for not nil in Elixir? E.g., First way: defp halt_if_not_signed_in(conn, signed_in_account) when...
New
siddhant3030
Hi, I have to write a raw query for one of my project. But till now I have used ecto queries and don’t have much experience writing raw ...
New
albydarned
Hello all! I am typing this post from my new MacBook Pro with the M1 chip. I’m loving it so far, and will probably use it as my daily dr...
New
TunkShif
This post is an instruction guide to help you setup your Neovim for Elixir development from scratch. It includes general information on h...
274 42716 114
New

We're in Beta

About us Mission Statement