Elixir: @doc in an @clean file

[Thomas Buttler]

The elixir language uses "@doc" as a documentation preamble for definitions; how does one instruct Leo to emit a verbatim "@doc"?

Collaboration with non-Leo users implies use of @clean.

[zhaohe wang]

I often use markdown text below @doc.

@language python

print("something")

@doc

@language md

### Print something

[tbp1...@gmail.com]

Leo has an elixir mode, so you could use it with

@language elixir

Are you already doing this?  It will let you emit an @adoc.  I tried it using an example I found at the ebook Learning Elixir Language.  Here is the content of my @clean node for the example:

@language elixir
defmodule MyModule do
 @doc """
 Given a number, returns `true` if the number is even, otherwise `false`.
 ## Example
 iex> MyModule.even?(2)
 true
 iex> MyModule.even?(3)
 false
 """

 def even?(number) do
 rem(number, 2) == 0
 end
end

The external file that Leo created seems to be exactly what you want.  I have attached it.

[tbp1...@gmail.com]

Sorry, typo, I meant " It will let you emit an @doc."

On Sunday, January 9, 2022 at 12:16:21 PM UTC-5 tbp1...@gmail.com wrote:

It will let you emit an @adoc.

[snip]

[Edward K. Ream]

On Fri, Jan 7, 2022 at 1:56 PM Thomas Buttler <thomasb...@gmail.com> wrote:

The elixir language uses "@doc" as a documentation preamble for definitions; how does one instruct Leo to emit a verbatim "@doc"?

In my tests in the latest devel code, Leo emits @doc as expected for both @file and @clean.

Edward