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

Include all exported functions in Test.jl documentation #37361

Merged
merged 1 commit into from
Apr 28, 2021

Conversation

tkf
Copy link
Member

@tkf tkf commented Sep 2, 2020

While writing #37360, I noticed that not all exported names are included in Test documentation. This patch fixes it.

Exported names

julia> join(stdout, sort!(string.(names(Test))), "\n")
@inferred
@test
@test_broken
@test_deprecated
@test_logs
@test_nowarn
@test_skip
@test_throws
@test_warn
@testset
GenericArray
GenericDict
GenericOrder
GenericSet
GenericString
Test
TestSetException
detect_ambiguities
detect_unbound_args

With this PR:

$ cd stdlib/Test/docs/src

$ grep '^Test\.' index.md | sed 's/^Test\.//g' | LANG=C sort
@inferred
@test
@test_broken
@test_deprecated
@test_logs
@test_nowarn
@test_skip
@test_throws
@test_warn
@testset
GenericArray
GenericDict
GenericOrder
GenericSet
GenericString
TestSetException
detect_ambiguities
detect_unbound_args
finish
get_testset
get_testset_depth
record

The first list (except Test) is a subset of the second list.

@tkf tkf added docs This change adds or pertains to documentation testsystem The unit testing framework and Test stdlib labels Sep 2, 2020
@vtjnash vtjnash added the merge me PR is reviewed. Merge when all tests are passing label Apr 20, 2021
@simeonschaub simeonschaub merged commit c31afce into JuliaLang:master Apr 28, 2021
@simeonschaub simeonschaub removed the merge me PR is reviewed. Merge when all tests are passing label Apr 28, 2021
ElOceanografo pushed a commit to ElOceanografo/julia that referenced this pull request May 4, 2021
jarlebring pushed a commit to jarlebring/julia that referenced this pull request May 4, 2021
antoine-levitt pushed a commit to antoine-levitt/julia that referenced this pull request May 9, 2021
johanmon pushed a commit to johanmon/julia that referenced this pull request Jul 5, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
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.

3 participants