Showing documentation comments about merlin HOT 9 CLOSED

+1 I think this would be very useful as well

from merlin.

I do also agree.

from merlin.

+1

(sorry for the spam)

from merlin.

Ocamldoc provides the documentation in a number of parse-able formats, so extracting the documentation should be possible. In terms of GUI, in VIM it could be mapped to K, which displays the man page by default (much like python mode uses pydoc, ocaml mode could use ocamldoc)

from merlin.

So, I have a branch ( ocamldoc ) which does that.
Remarks:

• it retrieves documentation comments from the cmts, not from sources. This means that if your build system uses camlp4, you won't have any documentation from merlin (as camlp4 drops the comments, so there's nothing in the cmts)
• the integration with vim/emacs is rudimentary, I am still working on it
• I'm reluctant to bind this to K in vim, K does work with ocaml (at least with the stdlib) and I'm not sure we want to break that.

from merlin.

Thomas, this is a great step forward.
On Fri, Mar 13, 2015 at 6:33 AM Thomas Refis [email protected]
wrote:

So, I have a branch ( ocamldoc ) which does that.
Remarks:

• it retrieves documentation comments from the cmts, not from sources.
  This means that if your build system uses camlp4, you won't have any
  documentation from merlin (as camlp4 drops the comments, so there's nothing
  in the cmts)
• the integration with vim/emacs is rudimentary, I am still working on
  it
• I'm reluctant to bind this to K in vim, K does work with ocaml (at
  least with the stdlib) and I'm not sure we want to break that.

—
Reply to this email directly or view it on GitHub
#55 (comment)
.

from merlin.

I see that this is now in Merlin 2.2, great job!
In emacs it works when I use company mode for completion and press F1, but not with auto-complete.
Is company mode the prefered completion engine for merlin or is it auto-complete?

from merlin.

If there was a favorite completion engine, I would say company-mode, because it's the one I use the most when I maintain emacs mode.

I am working on emacschism branch, to separate core merlin management from integration with other emacs services, in the hope it will make it easier to maintain and attract externel contribution.

from merlin.

Implemented for some time. More communication around the feature is coming.

from merlin.