fix doctests, and make them less prone to errors #26275
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
fredrikekre
commented
Mar 1, 2018
base/errorshow.jl
Outdated
| @@ -24,7 +24,7 @@ julia> sprint(showerror, err) | |||
| "MyException: test exception" | |||
|
|
|||
| julia> throw(MyException("test exception")) | |||
| ERROR: MyException: test exception | |||
| ERROR: MyException("test exception") | |||
There was a problem hiding this comment.
KristofferC
reviewed
Mar 1, 2018
| @@ -170,7 +170,7 @@ julia> ceil(Dates.Minute(44), Dates.Minute(15)) | |||
| 45 minutes | |||
|
|
|||
| julia> ceil(Dates.Hour(36), Dates.Day) | |||
| 3 days | |||
fredrikekre
force-pushed
the
fe/misc-doc
branch
5 times, most recently
from
6f594a3
to
6e6066c
Compare
fredrikekre
commented
Mar 2, 2018
| @@ -113,7 +113,7 @@ julia> isvalid(str, 2) | |||
| false | |||
|
|
|||
| julia> str[2] | |||
| ERROR: StringIndexError: invalid character index | |||
| ERROR: StringIndexError("αβγdef", 2) | |||
There was a problem hiding this comment.
This could use a custom showerror method with an explanation.
| @@ -312,7 +311,7 @@ since each character in a string must have its own index. The following is an in | |||
| verbose way to iterate through the characters of `s`: | |||
|
|
|||
| ```jldoctest unicodestring | |||
| julia> for i = begindex(s):lastindex(s) | |||
There was a problem hiding this comment.
Was begindex ever a thing?
| @@ -39,11 +39,11 @@ element type of `A`, e.g. for integer types. | |||
| ```jldoctest | |||
| julia> A = [4. 3.; 6. 3.] | |||
| 2×2 Array{Float64,2}: | |||
| 6.0 3.0 | |||
| 4.0 3.0 | |||
There was a problem hiding this comment.
When was this ever true?
|
Okay, this is no longer WIP, would be great if someone could give a quick review. |
fredrikekre
changed the title
KristofferC
reviewed
Mar 2, 2018
base/dict.jl
Outdated
|
|
||
| julia> getkey(a,'a',1) | ||
| julia> getkey(D,'a',1) |
There was a problem hiding this comment.
Could use spaces here to be consistent with the above.
KristofferC
reviewed
Mar 2, 2018
| @@ -250,6 +255,7 @@ pipeline? Instead of using `'|'` inside of backticks, one uses [`pipeline`](@ref | |||
| ```jldoctest | |||
| julia> run(pipeline(`echo hello`, `sort`)) | |||
| hello | |||
| Base.ProcessChain(Base.Process[Process(`echo hello`, ProcessExited(0)), Process(`sort`, ProcessExited(0))], RawFD(0x00000000), RawFD(0x00000001), RawFD(0x00000002), #undef) | |||
fredrikekre
commented
Mar 2, 2018
| @@ -273,8 +273,8 @@ that shells cannot. | |||
|
|
|||
| Julia can run multiple commands in parallel: | |||
|
|
|||
| ```julia-repl | |||
| julia> run(`echo hello` & `echo world`) | |||
| ```jldoctest; filter = r"(world\nhello|hello\nworld) | |||
There was a problem hiding this comment.
It is pretty nice that we can test examples like this now even though the order is undefined.
mbauman
added a commit
that referenced
this pull request
Mar 5, 2018
…luenonscalarindexedassignment * origin/master: (28 commits) fix an optimizer bug in `invoke` with non-constant functions (#26301) lower top-level statements in such a way that the front-end knows (#26304) Make sure Sockets page has h1 header (#26315) fix doctests, and make them less prone to errors (#26275) FIx intro to manual chapter on types (#26312) Add a missing "that" (#26313) fix docstring for code_llvm (#26266) Remove the examples/ folder (#26153) download cert.pem from deps-getall, fixes #24903 (#25344) Slight update to doc string for at-enum to refer to instances (#26208) performance tweak in reverse(::String) (#26300) remove references to `TCPSocket` in Base docstrings (#26298) Deprecate adding integers to CartesianIndex (#26284) Deprecate conj(::Any), add real(::Missing) and imag(::Missing) (#26288) fix #26267, regression in `names` with `imported=false` (#26293) fix #25857, `typeinfo` problem in showing arrays with abstract tuple types (#26289) Add adjoint(::Missing) method (#25502) Use lowered form in logging macro (#26291) deprecate bin, oct, dec, hex, and base in favor of `string` and keyword args (#25804) deprecate `spawn(cmd)` to `run(cmd, wait=false)` (#26130) ...
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 is a step towards #19528:
Later we should add functionality to fix all doctests (WIP here https://github.com/JuliaDocs/Documenter.jl/tree/fe/doctest-fix), which can then be run to update e.g. the line numbers before a release.
This is WIP because we need JuliaDocs/Documenter.jl#650 and a new Documenter release.
Note that there are a handful of doc updates here that we could have caught if doctests were enabled on CI.