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

Pretty docstrings #6417

Merged
merged 24 commits into from
Jan 4, 2024
Merged

Pretty docstrings #6417

merged 24 commits into from
Jan 4, 2024

Conversation

aspeddro
Copy link
Contributor

@aspeddro aspeddro commented Sep 28, 2023

  1. Add ```rescript metadata to codeblocks

    • I'm working on docgen and some pages don't have syntax highlighting, Belt API page
  2. Rename metadata from ```res example to rescript

    This change is for LSP clients to apply syntax highlighting for hover/signatureHelp, see Improving doc comments syntax highlighting in hovering rescript-vscode#545

    Neovim use the codeblock metadata to apply syntax highlight through tree-sitter parser feat(lsp): use treesitter for markdown floating windows neovim/neovim#25073

  3. Add ## Examples header

  4. Remove deprecated comments, use attr @deprecated

  5. Dedent comments

  6. Update ocaml comments to rescript format

I'll keep this as a draft and test it with the docgen

@aspeddro aspeddro changed the title Docstrings: add rescript codeblock metadata Pretty docstrings Oct 16, 2023
@aspeddro aspeddro marked this pull request as ready for review November 9, 2023 00:31
@cknitt cknitt merged commit 6dd6465 into rescript-lang:master Jan 4, 2024
@cknitt cknitt mentioned this pull request May 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants