#show_doc directive

[ivg]

This is a feature request :)

It would be nice to explore API documentation using utop, like in ipython.

[nilsbecker]

+1. i would propose #doc instead since that is faster to tab-complete: #show_doc is ambiguous with #show.

[hcarty]

merlin and ocp-index both provide mechanisms for viewing documentation which may be reusable here.

It may also be something worth pushing upstream to ocaml since the other #show toplevel directives come from there.

[rgrinberg]

Does this accomplish what you want: https://github.com/reynir/ocp-index-top

[nilsbecker]

the screenshot looks perfect!

[arichiardi]

Doc is quite a nice feature to have, I wonder if I can use it ReasonML as well. OCaml newbie here. Thanks for the nice pointer though!

[kandu]

What about "#infoof"? #294

[pmetzger]

BTW, I hadn't read this before, but ocp-index-top (as linked to by @rgrinberg above) looks quite nice!

[kandu]

I've looked ocp-index-top up. It's nice and I find that the first commit in #294 does the same as what ocp-index-top does. There is a small flaw, ocp-index-top indexes and queries identifiers in the same process of the REPL, it hangs and uses 100% CPU after you #require or #load some other libraries into the REPL and then query some info of the required library.

[pmetzger]

@kandu So do you see #294 as a full replacement for this? And does @ivg agree?

[kandu]

I didn't notice that this issue already existed when #294 was submitted.
The new directive shows the info containing name, kind, type and optional doc comment.
Because doc comments are not always presented, to name it as "show_doc" or "doc" may not be so suitable IMHO.