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

Add Syntax Documentation to vscode #1313

Merged
merged 8 commits into from
Jan 14, 2024

Conversation

PizieDust
Copy link
Contributor

@PizieDust PizieDust commented Dec 27, 2023

closes #1312

This PR adds a new GUI option for Syntax Documentation to this vscode extension.

This PR depends on ocaml/ocaml-lsp#1218 which is unmerged.

Screenshot 2023-12-27 075119

We can activate this feature using OCAMLLSP_ENABLE_SYNTAX_DOCUMENTATION in extraEnv or via ocaml.server

{
    "ocaml.server.extraEnv":{
        "OCAMLLSP_ENABLE_SYNTAX_DOCUMENTATION": "false"
    },
    "ocaml.server.syntaxDocumentation": false,
}

cc @voodoos @pitag-ha

@smorimoto
Copy link
Collaborator

Could you add a change log entry and run the code format?

@PizieDust
Copy link
Contributor Author

Could you add a change log entry and run the code format?

Thanks, done in the newest commits.

@smorimoto smorimoto added type: feature New feature or request ocamllsp labels Dec 28, 2023
@voodoos
Copy link
Collaborator

voodoos commented Jan 3, 2024

Thanks @PizieDust, looks good :-)

@mnxn
Copy link
Collaborator

mnxn commented Jan 13, 2024

The lint-fmt check is still failing. I think you need to format again.

@smorimoto smorimoto merged commit 8802822 into ocamllabs:master Jan 14, 2024
7 checks passed
@smorimoto smorimoto mentioned this pull request Jan 14, 2024
@voodoos
Copy link
Collaborator

voodoos commented Jan 15, 2024

@smorimoto I am not familiar with the interactions between the plugin and the server: what happens if a version of the plugin with this new configuration option is released but the server does not understand it ? (We still have to merge the Merlin PR and release it before merging the lsp-server one.) Will the option be shown even if it is not functional yet ?

@smorimoto
Copy link
Collaborator

It's shown even if it's not functional yet, but it doesn't cause the server to crash, so nothing should happen with this now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ocamllsp type: feature New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add GUI option for new Syntax Documentation command
5 participants