Merge pull request #56 from JuliaTesting/docs

Update documentation

Author: JamesWrigley

.github/workflows/Documentation.yml

@@ -11,10 +11,10 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - uses: julia-actions/setup-julia@latest
         with:
-          version: '1.5'
+          version: '1'
       - name: Install dependencies
         run: |
           julia --project=docs/ -e '
@@ -25,5 +25,4 @@ jobs:
       - name: Build and deploy
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # For authentication with GitHub Actions token
-          DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }} # For authentication with SSH deploy key
         run: julia --project=docs/ docs/make.jl

.gitignore

@@ -0,0 +1,2 @@
+*Manifest.toml
+docs/build

docs/Project.toml

@@ -4,4 +4,4 @@ InlineTest = "bd334432-b1e7-49c7-a2dc-dd9149e4ebd6"
 ReTest = "e0db7c4e-2690-44b9-bad6-7687da720f89"
 
 [compat]
-Documenter = "0.26"
+Documenter = "1"

docs/src/index.md

@@ -206,17 +206,20 @@ load
 ### Filtering tests
 
 * [`not`](@ref)
-* [`pass`](@ref) and `fail`
+* [`pass`](@ref) and [`fail`](@ref)
 * [`reachable`](@ref)
 * [`interpolated`](@ref)
 * [`depth`](@ref)
+* [`iter`](@ref)
 
 ```@docs
 not
 pass
+fail
 reachable
 interpolated
 depth
+iter
 ```
 
 

src/ReTest.jl

@@ -570,7 +570,7 @@ end
 
 revise_pkgid() = Base.PkgId(Base.UUID("295af30f-e4ad-537b-8983-00126c2a3abe"), "Revise")
 
-"accepted types as positional arguments of `retest`"
+# Accepted types as positional arguments of `retest`
 const ArgType = Union{Module,PatternX,AbstractString,AbstractArray,Tuple,Symbol,
                       Pair{Module,
                            <:Union{PatternX,AbstractString,AbstractArray,Tuple}}}

src/patterns.jl

@@ -518,14 +518,19 @@ depth(x::Integer) = Depth(Int(x))
 
 """
     pass
+
+Filtering pattern which matches any testset which already ran successfully.
+The pattern `[pass, fail]` matches any testset which already ran.
+"""
+pass
+
+"""
     fail
 
-Filtering patterns which match any testset which already ran,
-succesfully for `pass` or with at least one error for `fail`.
-The pattern `[pass, fail]` therefore matches any testset
-which already ran.
+Filtering pattern which matches any testset which already ran with at least one
+error. The pattern `[pass, fail]` matches any testset which already ran.
 """
-pass, fail
+fail
 
 """
     iter(i::Integer)

src/testset.jl

@@ -496,9 +496,7 @@ macro testset(mod::Module, isfinal::Bool, pat::Pattern, id::Int64, desc::Union{S
                             options, marks, stats, chan, loops, body, __source__)
 end
 
-"""
-Generate the code for a `@testset` with a `begin`/`end` argument
-"""
+# Generate the code for a `@testset` with a `begin`/`end` argument
 function testset_beginend(mod::Module, isfinal::Bool, pat::Pattern, id::Int64, desc, options,
                           marks::Marks, stats::Bool, chan, tests, source)
     # Generate a block of code that initializes a new testset, adds
@@ -555,9 +553,7 @@ function testset_beginend(mod::Module, isfinal::Bool, pat::Pattern, id::Int64, d
     return ex
 end
 
-"""
-Generate the code for a `@testset` with a `for` loop argument
-"""
+# Generate the code for a `@testset` with a `for` loop argument
 function testset_forloop(mod::Module, isfinal::Bool, pat::Pattern, id::Int64,
                          desc::Union{String,Expr}, options, marks::Marks, stats, chan,
                          loops, tests, source)