RFC: Allow doctests in Markdown code #13045
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
A good number were only blocked by having doctests.
mbauman
added
docs
13 tasks
| 1 | ||
| 0 | ||
| 0 | ||
| ```jl |
There was a problem hiding this comment.
this should also still be a doctest right?
There was a problem hiding this comment.
It wasn't originally. I believe the final two zeros are uninitialized, so it's not a deterministic test.
|
lgtm after removing the special case handling of |
jakebolewski
added a commit
that referenced
this pull request
Sep 10, 2015
RFC: Allow doctests in Markdown code
| @@ -11666,22 +11593,18 @@ While it isn't normally necessary, user-defined types can override the default ` | |||
| deepcopy | |||
|
|
|||
| doc""" | |||
| ```rst | |||
| .. widen(type | x) | |||
| widen(type | x) | |||
There was a problem hiding this comment.
I'm getting the feeling this should be 2 separate docstrings
|
backported in #13072 |
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.
Specify doctest with a ````jldoctest` code fence. I also converted the ~30 RST docstrings that were only blocked from conversion by a doctest code block.
CC @MichaelHatherly and @jakebolewski
Unfortunately this reflows the text within the generated stdlib, so the diff looks bigger than it actually is.