Add fallback Markdown -> Markdown2 convert methods #1075
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
It's easy to end up with Symbols, Ints or other arbitrary Julia objects in Markdown.MD trees. While it usually indicates a problematic docstring or a parser bug, this makes sure that we do not just crash in those situations. Rather, we just convert them to text nodes with repr().
fredrikekre
reviewed
Jul 26, 2019
Co-Authored-By: Fredrik Ekre <[email protected]>
Co-Authored-By: Fredrik Ekre <[email protected]>
|
Thanks @fredrikekre! |
Using the `@doc @doc(foo) bar` pattern wraps the docstrings in another layer of Markdown.MD, which needs to be unwrapped before converting to Markdown2.
As the Markdown parser technically allows you to have arbitrary Julia expressions in the Markdown tree, this makes sure that we do not crash with a missing method error in that situation.
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.
It's easy to end up with
Symbols,Ints or other arbitrary Julia objects inMarkdown.MDtrees. While it usually indicates a problematic docstring or a parser bug, this makes sure that we do not just crash in those situations. Rather, we just convert them to text nodes withrepr().Fix #1073.