feat: extensible Markdown rendering of Verso docstrings#14115
Draft
david-christiansen wants to merge 1 commit into
Draft
feat: extensible Markdown rendering of Verso docstrings#14115david-christiansen wants to merge 1 commit into
david-christiansen wants to merge 1 commit into
Conversation
This PR adds support for extensible Markdown rendering of Verso docstrings. Markdown rendering is used when docstrings are prepared for LSP hovers as well as for legacy clients that don't directly support Verso. Previously, when the docstring contained a custom element, Markdown rendering simply delegated to the alternate fallback rendering. Now, the custom elements can have custom rendering to Markdown. Example use cases include: * Including a docstring in another: with the module system, docstrings are part of the server olean and are loaded only in interactive sessions. If one docstring is to include another, it must be fetched at a time when the docstrings are loaded and available. A custom element can save which docstring is to be included at elaboration time, and then look it up at rendering time. * Showing a list of all currently-available instances of a class. * Showing names with respect to the currently-open namespaces. * Custom links to e.g. library notes that look up the destination in an environment extension.
|
Mathlib CI status (docs):
|
Collaborator
|
Reference manual CI status:
|
This file contains hidden or 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
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.
This PR adds support for extensible Markdown rendering of Verso docstrings.
Markdown rendering is used when docstrings are prepared for LSP hovers as well as for legacy clients that don't directly support Verso. Previously, when the docstring contained a custom element, Markdown rendering simply delegated to the alternate fallback rendering. Now, the custom elements can have custom rendering to Markdown.
Example use cases include:
Including a docstring in another: with the module system, docstrings are part of the server olean and are loaded only in interactive sessions. If one docstring is to include another, it must be fetched at a time when the docstrings are loaded and available. A custom element can save which docstring is to be included at elaboration time, and then look it up at rendering time.
Showing a list of all currently-available instances of a class.
Showing names with respect to the currently-open namespaces.
Custom links to e.g. library notes that look up the destination in an environment extension.