-
Notifications
You must be signed in to change notification settings - Fork 455
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
Pretty docstrings #6417
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
aspeddro
changed the title
Docstrings: add
Pretty docstrings
Oct 16, 2023
rescript
codeblock metadata
1 task
cknitt
approved these changes
Jan 4, 2024
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add
```rescript
metadata to codeblocksRename metadata from
```res example
torescript
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
Add
## Examples
headerRemove deprecated comments, use attr
@deprecated
Dedent comments
Update ocaml comments to rescript format
I'll keep this as a draft and test it with the docgen