chriseyre

chriseyre

External Documentation Packages

I have recently found how powerful the h command in iex is. It is however limited to packages with documentation, in particular it excludes the Erlang core libraries. This got me thinking, could we use an extension method where an Elixir package could have something like a Protocol that could be used to provide documentation on an external module? This would provide a great tool to prevent the reinvention of the wheel.

Has this been considered before?

On a related note we could use this as an Extension to Rebar to provide Erlang documentation for Elixir packages which may help bridge the Erlang and Elixir communities.

Most Liked

NobbZ

NobbZ

José Valim contributed the EEP 48, which as far as I know has been accepted. It describes how members of the BEAM ecosystem shall embed their documentation into the compiled modules.

Currently only elixir actually implements it. Erlang will do so from OTP 22 IIRC, so it will start in a couple of months.

I’m not sure what the state of LFE, Alpaca and others is currently.

Where Next?

Popular in Discussions Top

New
mbenatti
Following https://github.com/tbrand/which_is_the_fastest |> https://raw.githubusercontent.com/tbrand/which_is_the_fastest/master/imgs...
New
jer
I’ve been using umbrellas for a while, and generally started off (on greenfield projects at least) by isolating subapps based on clearly ...
New
chuck
Let me start by stating an assumption: Phoenix is a great approach to building REST APIs. There are many reasons for this, but I will ass...
New
PragTob
Hello everyone, I know we had quite some threads (read through lots of them) about background job processing but it remains a hotly deba...
New
Nvim
Elixir appears to be a superior language to Python. I don’t see any advantage of Python over Elixir. Are there any?
New
thojanssens1
It would be nice to be able to define a redirect from one route to another from the router.ex file. E.g.: redirect "/", UserController, ...
New

Other popular topics Top

rms.mrcs
Hi, I need to transform a list of numbers into a map where the keys are the indexes and the values are the original values of the list. ...
New
electic
Hi, I am new to Elixir. I am trying to use the DateTime component to insert a date into MySQL however the there seems to be no way to fo...
New
New
bsollish-terakeet
Credo is smart enough to check for (something like) this: assert length(the_list) == 0 with this response: Checking if an enum is empt...
New
shijith.k
I am trying to start a new phoenix project with elixir 1.9, but mix phx.new does not work. It says that ** (Mix) The task "phx.new" could...
New
romenigld
I am trying to run a deploy with docker and I successfully runned with this command: docker build -t romenigld/blog-prod . but when I t...
New

We're in Beta

About us Mission Statement