Fix doctest code-blocks in documentation #15753

vchuravy · 2016-04-03T10:37:52Z

Due to backtrace and printing changes most of the doctests are currently failing.

Remaining issues are:

Changed syntax errors

File "manual/variables.rst", line 131, in default
Failed example:
    try = "No"
Expected:
    ERROR: syntax: unexpected "="
Got:
    ERROR: syntax: unhandled expr (error #<julia: "unexpected "="">)
     in eval(::Module, ::Any) at ./boot.jl:237

Method overwritten

File "manual/stacktraces.rst", line 173, in default
Failed example:
    @noinline parent() = child()
Expected:
    parent (generic function with 1 method)
Got:
    WARNING: Method definition parent() in module Main at none:1 overwritten at none:1.
    parent (generic function with 1 method)

Changed Unit-range printing

File "manual/arrays.rst", line 312, in default
Failed example:
    searchsorted(a, 3)
Expected:
    3:2
Got:
    0-element UnitRange{Int64}

Inf in Tuple printing

Failed example:
    (typemin(Float16),typemax(Float16))
Expected:
    (-Inf16,Inf16)
Got:
    (-Inf,Inf)

Todo

Decide if unitrange is a regression (if not reformulate example)
Are syntax error a regression? (They seem to be less readable than before.)
Enable doctests on travis
Fix doctests in stdlib
Fix doctests in devdocs
What to do with method overwritten errors (They are clutter and don't add to the examples, on the other hand renaming the methods is excessive)

yuyichao · 2016-04-03T16:20:45Z

Ref #13966

yuyichao · 2016-04-03T16:21:40Z

What to do with method overwritten errors

I think we can just rename the method....

vchuravy · 2016-04-04T01:28:03Z

@nalimilan, was this intended to be a doctest?

File "manual/documentation.rst", line 42, in default
Failed example:
    bar([1, 2], [1, 2])
Expected:
    1
    ```
    """
    function bar(x, y) ...
Got:
    ERROR: UndefVarError: bar not defined
     in eval(::Module, ::Any) at ./boot.jl:237

Otherwise we are down to 40 failures all in the style described above. And where I am not quite certain how to proceed.

vchuravy · 2016-04-04T01:59:26Z

I renamed the problematic functions, but I am open to better suggestions.

Doctest summary
===============
 1056 tests
    7 failures in tests
    0 failures in setup code
    0 failures in cleanup code

vchuravy · 2016-04-07T11:11:32Z

I think we can merge this and I will open issues about the remaining failing tests.

nalimilan · 2016-04-07T16:07:18Z

That bar code block wasn't supposed to be a doctest. I think I kept how things were before without thinking too much about it.

vchuravy · 2016-04-08T06:19:45Z

Thanks fixed.

vchuravy · 2016-04-09T07:20:46Z

All done. All tests are now passing

Doctest summary
===============
 1058 tests
    0 failures in tests
    0 failures in setup code
    0 failures in cleanup code
build succeeded.

tkelman · 2016-04-09T18:49:04Z

doc/devdocs/types.rst

@@ -194,7 +194,7 @@ One can construct :obj:`TypeVar`\s manually:
 .. doctest::

   julia> TypeVar(:V, Signed, Real, false)
-   Signed<:V<:Real
+   V<:Real


what happened here?

fff2b9a should the in_env be false if the :tvar_env context is not found?

who should we be asking that question?

tkelman · 2016-05-05T19:31:57Z

Bump - this was great work, but goes stale quickly. Can you rebase and see where we stand?

vchuravy · 2016-05-14T13:22:14Z

I won't have time for a rebase till next week, but I will take a look after that.

omus · 2016-06-23T17:08:52Z

@vchuravy could you use assistance with this PR? I was hoping to add a new doctest.

Due to the changes in 4706184 tuples are now printed compact. Thus to demonstrate the point in this example we have to execute the examples independently.

vchuravy · 2016-06-23T18:38:59Z

@omus I just rebased, but there is an problem with Array printing that causes doctest to fail. I don't have time to look into it right now so feel free to give it a go.

tkelman · 2016-06-23T19:10:45Z

base/docs/helpdb/Base.jl

@@ -5643,7 +5643,8 @@ julia> deleteat!([6, 5, 4, 3, 2, 1], 1:2:5)

 julia> deleteat!([6, 5, 4, 3, 2, 1], (2, 2))
 ERROR: ArgumentError: indices must be unique and sorted
- in deleteat! at array.jl:543
+ in deleteat!(::Array{Int64,1}, ::Tuple{Int64,Int64}) at ./array.jl:565
+ in eval(::Module, ::Any) at ./boot.jl:237


I feel like the doctest system should be pruning this line

omus · 2016-06-24T15:45:03Z

I'm currently working on fixing doctests. Expect a PR before the end of JuliaCon

cb8aa0b - fix most doctests in the manual that changed due to backtraces. cd3797e - fix stdlib doctests 1892f72 - fix doctests in devdocs d9495c7 - resolve Warning mismatch by renaming functions 83ef854 - convert superflous doctest to code-block 78f6d70 - Fix example about typemax and typemin Due to the changes in 4706184 tuples are now printed compact. Thus to demonstrate the point in this example we have to execute the examples independently. c03e6e0 - fixup linenumbers 35a31bb - start->first Ref JuliaLang#15753

tkelman · 2016-06-25T12:35:52Z

I'm going to close this in favor of #17106 then, thanks to both @vchuravy and @omus

cb8aa0b - fix most doctests in the manual that changed due to backtraces. cd3797e - fix stdlib doctests 1892f72 - fix doctests in devdocs d9495c7 - resolve Warning mismatch by renaming functions 83ef854 - convert superflous doctest to code-block 78f6d70 - Fix example about typemax and typemin Due to the changes in 4706184 tuples are now printed compact. Thus to demonstrate the point in this example we have to execute the examples independently. c03e6e0 - fixup linenumbers 35a31bb - start->first Ref JuliaLang#15753

vchuravy changed the title ~~fixup doctest code-blocks in generator documentation~~ Fix doctest code-blocks in documentation Apr 3, 2016

vchuravy mentioned this pull request Apr 4, 2016

Isolating doctest blocks JuliaLang/JuliaDoc#20

Closed

This was referenced Apr 8, 2016

Regression in expanding of error AST #15798

Closed

Revert printing of ranges to v0.4 #15799

Merged

Doctests as part of travis #15815

Closed

tkelman reviewed Apr 9, 2016
View reviewed changes

vchuravy mentioned this pull request Apr 11, 2016

Documentation: array.rst #15826

Closed

tkelman mentioned this pull request May 5, 2016

Fix typo in variables-and-scoping.rst #16215

Merged

yuyichao mentioned this pull request May 8, 2016

ReshapedArrays, take2 #15449

Merged

yuyichao mentioned this pull request May 22, 2016

Update and finetune the output of commands in the latest doc #16511

Merged

yuyichao mentioned this pull request Jun 23, 2016

Doctests broken in 0.5 #17074

Closed

vchuravy added 5 commits June 24, 2016 03:34

fix most doctests in the manual that changed due to backtraces.

cb8aa0b

fix stdlib doctests

cd3797e

fix doctests in devdocs

1892f74

resolve Warning mismatch by renaming functions

d9495c7

convert superflous doctest to code-block

83ef854

vchuravy and others added 3 commits June 24, 2016 03:37

Fix example about typemax and typemin

78f6d70

Due to the changes in 4706184 tuples are now printed compact. Thus to demonstrate the point in this example we have to execute the examples independently.

fixup linenumbers

c03e6e0

start->first

35a31bb

tkelman reviewed Jun 23, 2016
View reviewed changes

omus mentioned this pull request Jun 25, 2016

Fix Doctests for 0.5-dev #17106

Merged

tkelman closed this Jun 25, 2016

yuyichao mentioned this pull request Jun 26, 2016

Display regression in assignment to composite type field #17123

Closed

vchuravy deleted the vc/fixup_docs branch October 28, 2016 14:46

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix doctest code-blocks in documentation #15753

Fix doctest code-blocks in documentation #15753

vchuravy commented Apr 3, 2016

yuyichao commented Apr 3, 2016

yuyichao commented Apr 3, 2016

vchuravy commented Apr 4, 2016

vchuravy commented Apr 4, 2016

vchuravy commented Apr 7, 2016

nalimilan commented Apr 7, 2016

vchuravy commented Apr 8, 2016

vchuravy commented Apr 9, 2016

tkelman Apr 9, 2016

yuyichao Apr 9, 2016

tkelman May 5, 2016

yuyichao May 5, 2016

tkelman commented May 5, 2016

vchuravy commented May 14, 2016

omus commented Jun 23, 2016

vchuravy commented Jun 23, 2016

tkelman Jun 23, 2016

omus commented Jun 24, 2016

tkelman commented Jun 25, 2016

Fix doctest code-blocks in documentation #15753

Fix doctest code-blocks in documentation #15753

Conversation

vchuravy commented Apr 3, 2016

Changed syntax errors

Method overwritten

Changed Unit-range printing

Inf in Tuple printing

Todo

yuyichao commented Apr 3, 2016

yuyichao commented Apr 3, 2016

vchuravy commented Apr 4, 2016

vchuravy commented Apr 4, 2016

vchuravy commented Apr 7, 2016

nalimilan commented Apr 7, 2016

vchuravy commented Apr 8, 2016

vchuravy commented Apr 9, 2016

tkelman Apr 9, 2016

Choose a reason for hiding this comment

yuyichao Apr 9, 2016

Choose a reason for hiding this comment

tkelman May 5, 2016

Choose a reason for hiding this comment

yuyichao May 5, 2016

Choose a reason for hiding this comment

tkelman commented May 5, 2016

vchuravy commented May 14, 2016

omus commented Jun 23, 2016

vchuravy commented Jun 23, 2016

tkelman Jun 23, 2016

Choose a reason for hiding this comment

omus commented Jun 24, 2016

tkelman commented Jun 25, 2016