psvensso/elixir-docs

Atom plugin for displaying Elixir docs directly in the editor

elixir-docs's Issues

Use --no-start

Starting up the application will mean the supervision tree will start up as well, which leaves an iex process running in the background causing potential side effects that the user is unaware is going on.

Instead, load up the application with iex -S mix run --no-start, you'll have access to docs and the supervision tree won't be started up!

Does not work on mac os x(?)

Hi I'm getting some errors when running on Mac OS X. elixir-docs can't find the iex executable (need to specify full path?). Then there are some other related problems with erl and mix respectively.

I made a very hackish change to make it work in my fork: vorce@f7c917e
Didn't want to send a PR for that since it introduced some configuration that is not exposed in an easy to add way. And not sure if it might break something on other platforms...

Cheers!

Can't find docs on Windows

[Enter steps to reproduce below:]

1. Just tried to use Find Doc command.

Atom Version: 1.4.3
System: Windows 10
Thrown From: elixir-docs package, v0.1.6

Stack Trace

Uncaught Error: This socket has been ended by the other party

At events.js:141

Error: This socket has been ended by the other party
    at Socket.writeAfterFIN [as write] (net.js:268:12)
    at atom-workspace.findhelp (C:\Users\alexa_000\.atom\packages\elixir-docs\lib\elixir-docs.js:76:7)
    at CommandRegistry.module.exports.CommandRegistry.handleCommandEvent (C:\Users\alexa_000\AppData\Local\atom\app-1.4.3\resources\app.asar\src\command-registry.js:260:29)
    at CommandRegistry.handleCommandEvent (C:\Users\alexa_000\AppData\Local\atom\app-1.4.3\resources\app.asar\src\command-registry.js:3:61)
    at CommandRegistry.module.exports.CommandRegistry.dispatch (C:\Users\alexa_000\AppData\Local\atom\app-1.4.3\resources\app.asar\src\command-registry.js:160:19)
    at AtomEnvironment.module.exports.AtomEnvironment.dispatchApplicationMenuCommand (C:\Users\alexa_000\AppData\Local\atom\app-1.4.3\resources\app.asar\src\atom-environment.js:1013:28)
    at emitOne (events.js:77:13)
    at EventEmitter.emit (events.js:169:7)

Commands

     -0:12 elixir-docs:finddoc (atom-text-editor.editor.is-focused)

Config

{
  "core": {
    "autoHideMenuBar": true,
    "disabledPackages": [
      "build-elixir"
    ],
    "projectHome": "C:"
  }
}

Installed Packages

# User
autocomplete-elixir, v1.5.12
elixir-cmd, v0.2.9
elixir-docs, v0.1.6
highlight-selected, v0.11.2
language-elixir, v0.8.0
minimap, v4.19.0
minimap-highlight-selected, v4.3.1
Remote-FTP, v0.7.15

# Dev
No dev packages

Local project files should be loaded in EIX

The terminal process should load up project urls from config or if null load cwd path.
Resulting in Docs being available for all modules in path.

Spawns 2 "beam" processes and orphans them

Setup

In the Atom package settings, find "elixir-docs". Separately, open an process monitor (on Linux with Gnome I open System Monitor). Filter the processes to "beam" so it only shows beam processes.

Steps to Reproduce

• Disable the elixir-docs package. No running beam processes close.
• Enable the elixir-docs package. 2 new beam processes are launched.
• Disable the elixir-docs package. No running beam processes close.
• Enable the elixir-docs package. 2 new beam processes are launched.

It creates 2 beam processes at a time and orphans them. When Atom is closed, these processes remain running but are orphaned.