Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

#1628 Feature/1628 Pop out documentation #1792

Conversation

marcindawidziuk
Copy link
Contributor

Hi, let me first say that this plugin is awesome.
The one big thing that was missing for me as an Elixir noobie is documentation.
This PR adds a very basic IEx based Documentation Provider, that so far have worked okay-ish in my Phoenix based project. Is that approach even a correct way to fetch docs?

Any and all feedback would be appriciated.

@marcindawidziuk marcindawidziuk changed the title Feature/1628 Pop out documentation #1628 Feature/1628 Pop out documentation Jun 23, 2020
@KronicDeth KronicDeth added this to the v11.7.1 milestone Jul 31, 2020
@KronicDeth
Copy link
Owner

Is that approach even a correct way to fetch docs?

This is one way to do it. You could also do something like how the debugger works where it uses JInterface to talk to a running BEAM process. Finally, you could read the docs out of the .beam files are render them all in Kotlin/Java. That was the way I would have done it, but this is a good start for now. Having something to iterate on is better than having no docs. ❤️

@KronicDeth KronicDeth self-assigned this Jul 31, 2020
@KronicDeth
Copy link
Owner

KronicDeth commented Jul 31, 2020

Resolves #1628

Changelog

Enhancements

  • Quick documentation (F1/Ctrl+Q)

@KronicDeth
Copy link
Owner

Works for fully-qualified module function and arity even in pipelines

Screen Shot 2020-07-31 at 12 14 07 PM

Doesn't take into account aliasing

Screen Shot 2020-07-31 at 12 14 39 PM

I'll look into if I can fix that before merging.

@KronicDeth
Copy link
Owner

It not working with aliased modules is a bug in resolveModuleName since I said it should work with aliases. Find usage works with calls on aliases, so I must have a method that works for that, probably using references directly and not using resolvedModuleName, so it is just resolvedModuleName that is bugged.

@KronicDeth
Copy link
Owner

Resolving the resolvedModuleName will be a larger change that I don't want to mix with your changes, so I'll add it later.

@KronicDeth KronicDeth merged commit e41bd55 into KronicDeth:master Aug 2, 2020
@marcindawidziuk marcindawidziuk deleted the feature/1628-pop-out-documentation branch August 3, 2020 08:39
@KronicDeth KronicDeth linked an issue Aug 4, 2020 that may be closed by this pull request
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Pop up documentation
2 participants