RooSoft

RooSoft

Earmark warning: Illegal attributes ignored in IAL

Why is it that when I run mix docs, I get this error

warning: ExDoc.Markdown.Earmark (warning) lib/key/hd/mnemonic_seed/wordlist.ex:39 Illegal attributes ["\"absurd\"", "8,", "found,"] ignored in IAL

for this function?

Seems like ExDoc.Markdown.Earmark doesn’t like atoms somehow…

First 4 of 4 Posts! Switch mode

al2o3cr

al2o3cr

Seems like this has been an issue for a while:

https://github.com/pragdave/earmark/issues/141

One thing that stands out: both doctests and code-blocks use a four space indent, starting from the surrounding content. Your example only indents two spaces:

https://github.com/RooSoft/bitcoinlib/blob/9c96f0a96c8fc0d2bedca7b654c290f143bb06fd/lib/key/hd/mnemonic_seed/wordlist.ex#L37-L39

RooSoft

RooSoft

I’ve indented it further to 4, and the warning disappeared!

Thanks al2o3cr!

Will reindent, but that’s definitely not ideal…

RobertDober

RobertDober

One could discuss if IAL makes sense for ex_doc maybe you should discuss it with them, however the correct way to escape IAL is as follows

iex(9)> EarmarkParser.as_ast("a\n\\{:a, 1}")
{:ok, [{"p", [], ["a\n{:a, 1}"], %{}}], []}
Sinc

Sinc

I found that this error can also occur for some tuples in @doc code:

    Perform a license check.

    ## Arguments

    * The first argument is the result of the license check.
    * The second argument is {params, socket.assigns}

    ## Return

    * true for success
    * {:error, error_atom} for failure.

Only the line containing {:error, error_atom} generated a warning, and interestingly complaining about the two parts in reverse order (as they were for RooSoft). Adding back ticks around the tuple resolved the issue for me.

Where Next?

Trending in Questions Top

jonnycharles
I’m in search of an Elixir library that offers PDF generation capabilities similar to Ruby’s Prawn. While there have been discussions abo...
New
spammy
I’m looking to build a personal workflow to quickly deploy web applications written in elixir/phoenix, for local consumption (ie not on t...
New
silverdr
Using Phoenix.LiveView.TagEngine as an EEx.Engine is deprecated! To compile HEEx, use Phoenix.LiveView.TagEngine.compile/2 instead. Sta...
New
saveman71
Hello ! We want new/edit form pages to POST/PUT to their own URL rather than the resources REST defaults (post /things, put /things/:id)...
New
dli
Before I dive in myself, did anyone successfully sprinkle Hologram into their existing LiveView app? Looking for hints regarding: Addi...
New
bottlenecked
Hi all, I wanted to ask how the community is dealing with post-release steps. Today we have Ecto migrations, which make sure that the db...
New
michallepicki
I am using Oban and occasionally, shortly after a deployment, a handful of jobs can fail because of dependency on other parts of the syst...
New

Other Trending Topics Top

JesseHerrick
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
jimsynz
Beam Bots (or just BB for short) is a framework for building fault-tolerant robotics applications in Elixir using familiar OTP patterns. ...
New
Damirados
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
ausimian
Emily is an Elixir library that runs Nx computations on Apple’s MLX. Install it as the default Nx backend and Nx, defn, Axon, Nx.Serving,...
New
type1fool
I just stumbled on a newly redesigned elixir-lang.org. :tada: It looks like @Software_Mansion did the work, and I think it is generally a...
New
akoutmos
@hugobarauna and I (Alex Koutmos) have been hard at work on writing a book on Nerves that takes you from simply blinking LEDs to building...
New

We're in Beta

About us Mission Statement