This repository was archived by the owner on May 5, 2020. It is now read-only.
Fixes to doctest processing #23
Merged
Conversation
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
The `dump` call was not providing a trailing newline which was causing the doctests to hang since the seperator never appeared on its own line. Code has been changed such that the seperator will always appear after a newline.
Issue was due to `self._checker.output_difference` and `self._failure_header` sometimes returning different types (unicode and string).
juliadoc/jldoctest.py
Outdated
| j = Popen(["../julia"], stdin=PIPE, stdout=PIPE, stderr=STDOUT) | ||
| j.stdin.write("macro raw_str(s) s end;nothing\n".encode('utf-8')) | ||
| j.stdin.write("_ans = nothing\n".encode('utf-8')) | ||
| j.stdin.write("pushdisplay(TextDisplay(IOContext(IOContext(STDOUT, :multiline => true), :limit => true))); nothing\n".encode('utf-8')) |
There was a problem hiding this comment.
I guess this now becomes 0.5-only. So if any bugfixes are ever needed to JuliaDoc for 0.4 we can go back and branch.
There was a problem hiding this comment.
Good point. I could always throw a VERSION conditional in.
Additionally broke up the long `pushdisplay` line.
| # read separator | ||
| sep = 'fjsdiij3oi123j42' | ||
| self.julia.stdin.write(('println("' + sep + '")\n').encode('utf-8')) | ||
| self.julia.stdin.write(('println("\\n' + sep + '")\n').encode('utf-8')) |
There was a problem hiding this comment.
does this become unnecessary if dump gets fixed / changed back? or is it harmless to have anyway?
There was a problem hiding this comment.
Technically we don't need this fix if dump gets fixed. I definitely still want to include this fix as it seems unreasonable for doctests to hang forever just because the output of a call doesn't have a trailing newline.
omus
added a commit
to omus/julia
that referenced
this pull request
Jun 29, 2016
omus
added a commit
to omus/julia
that referenced
this pull request
Jul 7, 2016
omus
added a commit
to omus/julia
that referenced
this pull request
Jul 8, 2016
omus
added a commit
to omus/julia
that referenced
this pull request
Jul 11, 2016
mfasi
pushed a commit
to mfasi/julia
that referenced
this pull request
Sep 5, 2016
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
2 participants
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.
While updating the doctests for JuliaLang/julia#17106 I encountered several bugs with how doctests were being processed.