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

Display cross reference in odoc on hover #1258

Open
tysg opened this issue Oct 27, 2023 · 0 comments
Open

Display cross reference in odoc on hover #1258

tysg opened this issue Oct 27, 2023 · 0 comments
Labels
type: bug Something isn't working

Comments

@tysg
Copy link

tysg commented Oct 27, 2023

The VSCode plugin is able to properly render verbatim/code text wrapped with [] in the popup on hover, but doesn't display anything when wrapped with !{} (cross reference syntax).

For example this:

(** Create new thread wrapped in {!Action.log} *)
val log_create : ?name:string -> ('a -> unit) -> 'a -> Thread.t

is rendered like this:

Screenshot 2023-10-27 at 4 51 55 PM

I'm unsure if this is an issue upstream because it feels like a rendering issue, although I found ocaml/ocaml-lsp#436

@smorimoto smorimoto added the type: bug Something isn't working label Oct 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants