Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update at-testset docs for verbose option #38447

Merged
merged 2 commits into from
Dec 1, 2020
Merged

Conversation

rfourquet
Copy link
Member

This option was added in #33755.

@rfourquet rfourquet added domain:docs This change adds or pertains to documentation testsystem The unit testing framework and Test stdlib labels Nov 15, 2020
@rfourquet rfourquet changed the title update at-testset docstring for verbose option update at-testset docs for verbose option Nov 15, 2020
@ronisbr
Copy link
Sponsor Member

ronisbr commented Nov 28, 2020

Thanks! I really forgot the docs when I created that PR.

@@ -134,7 +134,8 @@ Foo Tests | 8 8
```

In the event that a nested test set has no failures, as happened here, it will be hidden in the
summary. If we do have a test failure, only the details for the failed test sets will be shown:
summary, unless the `verbose=true` option is passed.
Copy link
Sponsor Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you please add here the following example:

julia> @testset verbose = true "Foo Tests" begin
           @testset "Animals" begin
               @test foo("cat") == 9
               @test foo("dog") == foo("cat")
           end
           @testset "Arrays $i" for i in 1:3
               @test foo(zeros(i)) == i^2
               @test foo(fill(1.0, i)) == i^2
           end
       end;
Test Summary: | Pass  Total
Foo Tests     |    8      8
  Animals     |    2      2
  Arrays 1    |    2      2
  Arrays 2    |    2      2
  Arrays 3    |    2      2

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good idea! It's added now.

Copy link
Sponsor Member

@ronisbr ronisbr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice! LGTM.

@rfourquet
Copy link
Member Author

There is one unrelated failure, in LinearAlgebra: https://build.julialang.org/#/builders/52/builds/5874/steps/5/logs/stdio. Maybe worth a look by someone knowing this code (@andreasnoack).

@rfourquet
Copy link
Member Author

@ronisbr thanks for your review, it helps to click merge! (although I can't really do it blindly in this case ;-) )

@rfourquet rfourquet merged commit 8c35003 into master Dec 1, 2020
@rfourquet rfourquet deleted the rf/doc/testset-verbose branch December 1, 2020 12:25
@ronisbr
Copy link
Sponsor Member

ronisbr commented Dec 1, 2020

@ronisbr thanks for your review, it helps to click merge! (although I can't really do it blindly in this case ;-) )

Sorry! I do not have write access. I "approve" because everything you wrote about verbose was right :)

@rfourquet
Copy link
Member Author

Sorry! I do not have write access.

No, I meant your approval helped me to click merge! (otherwise I would have simply waited for someone else to merge)

@ronisbr
Copy link
Sponsor Member

ronisbr commented Dec 1, 2020

Oh nice! Sorry again 😅

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
domain:docs This change adds or pertains to documentation testsystem The unit testing framework and Test stdlib
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants