chriseyre
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.
Where Next?
Trending in Discussions
Other Trending Topics
Latest on Elixir Forum
Sponsor Spotlight
Practical resources that improve the lives of professional developers.
Categories:
Sub Categories:
Forums
Popular Tags
- #ecto
- #liveview
- #troubleshooting
- #learning-elixir
- #library
- #deployment
- #erlang
- #testing
- #genserver
- #mix
- #absinthe
- #remote-other
- #otp
- #plug
- #how-to-question
- #macros
- #postgres
- #elixirconf
- #channels
- #exunit
- #discussion
- #code-sync
- #podcasts
- #javascript
- #onsite
- #dialyzer
- #docker
- #authentication
- #umbrella
- #full-time-contract
- #podcasts-by-brainlid
- #ecto-query
- #ai
- #elixirconf-us
- #blog-post
- #elixir-ls
- #phoenix_html
- #iex
- #graphql
- #genstage
- #websockets
- #supervisor
- #advent-of-code
- #distillery
- #processes
- #api
- #forms
- #hex
- #security
- #metaprogramming
Our Sponsors
Build Elixir applications with speed and confidence.
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.
Elixir, Erlang & BEAM conferences from Code Sync - join us in 2026!
Practical resources that improve the lives of professional developers.
Master modern tools, write cleaner code, and tackle real-world challenges.
Bringing learning, work and compliance together since 1987.
The team behind Membrane, Popcorn, LiveDebugger. Available for hire.
Courses that'll move you from confusion to "Aha, now I get it!"
Showing Posts 1 to 1- Show Best Posts
- Show All (oldest first)
- Show All (newest first)
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.