-
Notifications
You must be signed in to change notification settings - Fork 124
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 text of references in doc strings #1166
Conversation
Thanks @AurelienSaue! Could you add a test that showcases the improvement? #1088 should show how to do this. |
I added a test, I hope I did it right |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good to me if CI is happy!
I am confused by the error, I am not sure it comes from my addition. |
It's not, we've had recurring problems with the Windows CI. @rgrinberg or @voodoos I'll let you merge when you think this is ready, I was chiming in since I wrote a good part of the new markdown conversation, but I'll leave the merge to you. |
CHANGES: ## Fixes - Fix missing super & subscripts in markdown documentation. (ocaml/ocaml-lsp#1170) - Do not invoke dune at all if `--fallback-read-dot-merlin` flag is on. (ocaml/ocaml-lsp#1173) - Fix semantic highlighting of infix operators that contain '.'. (ocaml/ocaml-lsp#1186) - Disable highlighting unit as an enum member to fix comment highlighting bug. (ocaml/ocaml-lsp#1185) - Improve type-on-hover and type-annotate efficiency by only formatting the type of the first enclosing. (ocaml/ocaml-lsp#1191, ocaml/ocaml-lsp#1196) - Fix the encoding of URI's to match how vscode does it (ocaml/ocaml-lsp#1197) - Fix parsing of completion prefixes (ocaml/ocaml-lsp#1181) ## Features - Compatibility with Odoc 2.3.0, with support for the introduced syntax: tables, and "codeblock output" (ocaml/ocaml-lsp#1184) - Display text of references in doc strings (ocaml/ocaml-lsp#1166) - Add mark/remove unused actions for open, types, for loop indexes, modules, match cases, rec, and constructors (ocaml/ocaml-lsp#1141) - Offer auto-completion for the keyword `in` (ocaml/ocaml-lsp#1217)
CHANGES: ## Fixes - Fix missing super & subscripts in markdown documentation. (ocaml/ocaml-lsp#1170) - Do not invoke dune at all if `--fallback-read-dot-merlin` flag is on. (ocaml/ocaml-lsp#1173) - Fix semantic highlighting of infix operators that contain '.'. (ocaml/ocaml-lsp#1186) - Disable highlighting unit as an enum member to fix comment highlighting bug. (ocaml/ocaml-lsp#1185) - Improve type-on-hover and type-annotate efficiency by only formatting the type of the first enclosing. (ocaml/ocaml-lsp#1191, ocaml/ocaml-lsp#1196) - Fix the encoding of URI's to match how vscode does it (ocaml/ocaml-lsp#1197) - Fix parsing of completion prefixes (ocaml/ocaml-lsp#1181) ## Features - Compatibility with Odoc 2.3.0, with support for the introduced syntax: tables, and "codeblock output" (ocaml/ocaml-lsp#1184) - Display text of references in doc strings (ocaml/ocaml-lsp#1166) - Add mark/remove unused actions for open, types, for loop indexes, modules, match cases, rec, and constructors (ocaml/ocaml-lsp#1141) - Offer auto-completion for the keyword `in` (ocaml/ocaml-lsp#1217)
This PR does not add support for cross-references, but Doc_to_md now outputs the text of the reference, instead of a line break as it does currently.