alisinabh
Ex_docs some examples not showing
Hi
I’ve recently faced a problem with doc tests on html documents:
Here is my code and docs:
@doc """
Does something good!
## Examples
iex> Module.do_something
{:ok, 123}
iex> Module.do_something
:error
"""
def do_something() do
...
end
In the documents the output will be like:
Examples
iex> Module.do_something
iex> Module.do_something :error
As you can see the tuple in the first example is missing in the docs. Am i doing something wrong?
Marked As Solved
voughtdq
Hi, have you put four spaces before the doc tests? It looks like you haven’t, but it might have just been caused by copy/paste.
@doc """
Articulates the given frob.
## Examples
iex> frob = %Frob{}
iex> Articulator.articulate(frob)
{:ok, %Frob{articulated: true}}
"""
def articulate(%Frob{}) do
{:ok, %Frob{articulated: true}}
end
Until I changed my doctests to what you see above, weird things happened.
Last Post!
alisinabh
Popular in Questions
Other popular topics
Latest on Elixir Forum
Sponsor Spotlight
Supporting innovation across the BEAM ecosystem.
Categories:
Sub Categories:
Forums
Popular Tags
- #ecto
- #liveview
- #troubleshooting
- #learning-elixir
- #deployment
- #library
- #erlang
- #testing
- #genserver
- #mix
- #absinthe
- #remote-other
- #otp
- #plug
- #how-to-question
- #macros
- #postgres
- #channels
- #elixirconf
- #exunit
- #discussion
- #code-sync
- #javascript
- #podcasts
- #onsite
- #dialyzer
- #docker
- #authentication
- #umbrella
- #full-time-contract
- #podcasts-by-brainlid
- #ecto-query
- #elixir-ls
- #phoenix_html
- #iex
- #blog-post
- #graphql
- #genstage
- #ai
- #websockets
- #supervisor
- #elixirconf-us
- #advent-of-code
- #distillery
- #processes
- #api
- #forms
- #metaprogramming
- #security
- #hex
Our Sponsors
Build Elixir applications with speed and confidence.
Supporting innovation across the BEAM ecosystem.
We build reliable cloud platforms for business-critical systems.
Catch errors, track performance, monitor hosts and more.
Error tracking, logs, uptime, and Just Enough APM. Built for developers.
Practical resources that improve the lives of professional developers.
Enabling companies to succeed by building software people love.
The deployment platform built for Elixir: PaaS ease, VPS control.
The team behind Membrane, Popcorn, LiveDebugger. Available for hire.
Courses that'll move you from confusion to "Aha, now I get it!"