Skip to content

Commit cefb434

Browse files
committed
Get rid of @/meta blocks in {CUDA,}ChaChaKeystream docstrings
Get rid of `meta` blocks in docstrings, since they show up in the REPL. Trailing `meta` blocks also show up in the HTML API documentation, which we don't really want.
1 parent 09dcdaa commit cefb434

File tree

2 files changed

+2
-25
lines changed

2 files changed

+2
-25
lines changed

src/cuda_keystream.jl

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -14,24 +14,12 @@ generator for GPU CRNG.
1414
Create a `CUDAChaChaStream` with a randomized key, and
1515
sample some random numbers with it:
1616
17-
```@meta
18-
DocTestSetup = quote
19-
using CUDA
20-
using ChaChaCiphers
21-
using Random
22-
end
23-
```
24-
2517
```julia
2618
julia> rng = CUDAChaChaStream();
2719
2820
julia> x = CuVector{Float32}(undef, 2^10);
2921
```
3022
31-
```@meta
32-
DocTestSetup = nothing
33-
```
34-
3523
See also: [`ChaChaStream`](@ref)
3624
"""
3725
mutable struct CUDAChaChaStream <: AbstractChaChaStream

src/keystream.jl

Lines changed: 2 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -15,21 +15,14 @@ generation functions.
1515
1616
Create a `ChaChaStream` with a randomly-generated key and nonce:
1717
18-
```@meta
19-
DocTestSetup = quote
20-
using ChaChaCiphers
21-
using Random
22-
end
23-
```
24-
25-
```jldoctest
18+
```jldoctest; setup = :(using ChaChaCiphers, Random)
2619
julia> stream = ChaCha20Stream();
2720
```
2821
2922
Create a `ChaChaStream` with a pre-specified key and nonce, and
3023
use it to generate random data:
3124
32-
```jldoctest
25+
```jldoctest; setup = :(using ChaChaCiphers, Random)
3326
julia> key = UInt32.([
3427
0xe2e39848, 0x70bb974d, 0x845f88b4, 0xb30725e4,
3528
0x15c309dc, 0x72d545bb, 0x466e99e3, 0x6a759f91
@@ -46,10 +39,6 @@ julia> randstring(stream, 'a':'z', 8)
4639
"klmptewr"
4740
```
4841
49-
```@meta
50-
DocTestSetup = nothing
51-
```
52-
5342
See also: [`CUDAChaChaStream`](@ref)
5443
"""
5544
mutable struct ChaChaStream <: AbstractChaChaStream

0 commit comments

Comments
 (0)