wojtekmach
IExHelpOpen - opens documentation in a browser window
Hey everyone,
As you might know, Hex recently got a new option to open up documentation for a particular module in a browser window, e.g.: mix hex.docs open ecto --module Ecto.Changeset which I find very useful.
I thought it would be cool to have similar ability inside an iex session so I built: GitHub - wojtekmach/iex_help_open · GitHub.
Here’s a quick demo how this works:
It’s in a very early version and supports just functions, but if there’s interest in it I’d be happy to extend it to support more features. (It would likely require a rewrite from scratch 
.) Any feedback and/or contributions are very welcome in the meantime!
Trending in Announcing
Other Trending Topics
Latest on Elixir Forum
Sponsor Spotlight
Deploy Phoenix to your own VPS with PaaS ease: push-to-deploy, zero downtime, auto SSL, managed Postgres. 14-day free trial at potions.io
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
- #elixirconf-us
- #supervisor
- #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.
Producing high quality Elixir screencasts since 2017.
Enabling companies to succeed by building software people love.
The team behind Membrane, Popcorn, LiveDebugger. Available for hire.
Courses that'll move you from confusion to "Aha, now I get it!"
First 3 of 3 Posts!
gon782
Ah, goodness, this is great! These are the types of tools we really need. I had in mind to make a remote version of this at some point, because I wanted to use it across VM/machine boundaries, so I could spawn new tabs of docs on other machines or outside my VM. I might actually take a look at this to extend it into that. Thanks for rekindling this.
bbense
With Ehelper I got as far as printing out the url’s for everything you can access via the h command, the standard Erlang libraries, and anything you have installed via hex.
https://github.com/philosophers-stone/ehelper/blob/master/lib/doc_help/print_url.ex
I just looked at the openurl helper and it needs some TLC. I’m thinking some code got lost along the way since
it opens dash url’s.
wojtekmach
nice! I’ve only learned about ehelper some hours after publishing the package above
the code I’m using for that is taken from hex and it seems to work pretty well: hex/lib/mix/tasks/hex/docs.ex at v0.15.0 · hexpm/hex · GitHub so I suppose it could be that if the user has dash installed then it uses that, otherwise opens it up in the browser.