Skip to content

Commit 4d0e46a

Browse files
authored
add doctest in unittest (#229)
1 parent 28e72f8 commit 4d0e46a

File tree

3 files changed

+6
-2
lines changed

3 files changed

+6
-2
lines changed

Project.toml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,8 @@ Statistics = "10745b16-79ce-11e8-11f9-7d13ad32a3b2"
1010
julia = "1"
1111

1212
[extras]
13+
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
1314
Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
1415

1516
[targets]
16-
test = ["Test"]
17+
test = ["Documenter", "Test"]

src/FixedPointNumbers.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -168,7 +168,7 @@ except in scenarios where they are guaranteed to have hardware support.
168168
169169
A classic usage is to avoid overflow behavior by promoting `FixedPoint` to `AbstractFloat`
170170
171-
```jldoctest
171+
```jldoctest; setup = :(using FixedPointNumbers)
172172
julia> x = N0f8(1.0)
173173
1.0N0f8
174174

test/runtests.jl

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@ else
66
@test isempty(detect_ambiguities(FixedPointNumbers, Base, Core))
77
end
88

9+
using Documenter
10+
doctest(FixedPointNumbers, manual = false)
11+
912
@testset "normed" begin
1013
include("normed.jl")
1114
end

0 commit comments

Comments
 (0)