Assume that docstring code with no lang is julia #55465
Merged
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
By making this assumption when parsing docstrings, we can remove the assumption that all no-lang Markdown code blocks are in fact Julia without compromising docstring highlighting.
tecosaur
force-pushed
the
assume-julia-docstrings
branch
from
6fc2915
to
3b8bd74
Compare
KristofferC
reviewed
Aug 13, 2024
|
👍, this seems better to me |
|
Although doing it like Documenter where only the first code block is assumed to be Julia might be even better. The doctests etc later typically have |
|
Personally "the default code language in Julia docstrings is Julia" makes sense to me, I'm not sure if it would be a good idea to restrict it to the first code block only or not? I know code I've written there are instances where I've used indentation for Julia code multiple times, but I don't have a good sense off the top of my head of the general situation. |
KristofferC
added
the
status:merge me
giordano
removed
the
status:merge me
# for free
to join this conversation on GitHub.
Already have an account?
# 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.
By making this assumption when parsing docstrings, we can remove the assumption that all no-lang Markdown code blocks are in fact Julia without compromising docstring highlighting.