We Want Your Feedback on the odoc Developer Experience

Community
,
1

Hey all, :orange_heart::camel:

the documentation team at Tarides is looking for input and feedback on odoc.

I would be super happy if everyone who uses odoc or would use odoc if it worked for them can drop an answer in this feedback form:

4 Likes
2

Not sure if this directly an odoc thing but is there a merlin command to show the documentation of a symbol? Same question for utop. I’m thinking of something much like #show in utop but the odoc is rendered instead of the type definitions.

Thanks

1 Like
3

I think this is (setq merlin-completion-with-doc t) ~but here it doesn’t seem to work (but I vaguely remember it working, it wouldn’t render it though, it would simply show you the doc string)~. It works on completion, not on C-c t.

2 Likes
4

for merlin, in emacs it is the function merlin-document (I don’t know whether it has a default keybinding). as @dbuenzli said it shows the whole documentation comment for the value under the cursor, it doesn’t render as HTML/emacs-doc

1 Like
5

I didn’t see a similar binding for vim- did I miss something?

6

I’m not sure it would make much sense unless you can actually make links point into the docsets.

I have a long standing issue in odig to try to integrate some form of open the doc of that identifier in the docset. Then rendering the snippets (or extracting them from docsets) could actually make sense. The browser averse person could then combine that with emacs’ eww to get a pretty nice in-editor documentation experience (see also this issue)… hand waves.

Isn’t that a related issue ?

1 Like
7

I didn’t see a similar binding for vim- did I miss something?

Does MerlinDocument not work? (This is a genuine question. I’m not a Vim user)

8

It does in fact work, I don’t know if it’s because I set

let g:merlin_completion_with_doc = 1

which made it work all of a sudden or I just forgot what the command was.

Thanks for the help everyone!

1 Like