fixed jldoctest

awesome-spectral-indices · Dec 10, 2023 · b4d6ec7 · b4d6ec7
1 parent 655e011
commit b4d6ec7
Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/src/axioms.jl b/src/axioms.jl
@@ -160,11 +160,13 @@ parameters, and optional keyword arguments.
 # Examples
 
 ```jldoctest
+julia> using SpectralIndices
 julia> compute(NDVI; N=0.643, R=0.175)
 0.5721271393643031
 ```
 
 ```jldoctest
+julia> using SpectralIndices
 julia> compute(NDVI; N=fill(0.643, (5, 5)), R=fill(0.175, (5, 5)))
 0.572127  0.572127  0.572127  0.572127  0.572127
 0.572127  0.572127  0.572127  0.572127  0.572127

diff --git a/src/compute.jl b/src/compute.jl
@@ -22,11 +22,13 @@ based on the provided index name, parameters, and optional keyword arguments.
 # Examples
 
 ```jldoctest
+julia> using SpectralIndices
 julia> compute_index("NDVI"; N=0.643, R=0.175)
  0.572127
 ```
 
 ```jldoctest
+julia> using SpectralIndices
 julia> compute_index("NDVI"; N=fill(0.643, (5, 5)), R=fill(0.175, (5, 5)))
  0.572127  0.572127  0.572127  0.572127  0.572127
  0.572127  0.572127  0.572127  0.572127  0.572127
@@ -36,6 +38,7 @@ julia> compute_index("NDVI"; N=fill(0.643, (5, 5)), R=fill(0.175, (5, 5)))
 ```
 
 ```jldoctest
+julia> using SpectralIndices
 julia> compute_index("NDVI"; N=fill(0.643, 5), R=fill(0.175, 5))
 0.5721271393643031
 0.5721271393643031
@@ -45,18 +48,21 @@ julia> compute_index("NDVI"; N=fill(0.643, 5), R=fill(0.175, 5))
 ```
 
 ```jldoctest
+julia> using SpectralIndices
 julia> compute_index(["NDVI", "SAVI"]; N=fill(0.643, 5), R=fill(0.175, 5), L=fill(0.5, 5))
 [0.5721271393643031, 0.5721271393643031, 0.5721271393643031, 0.5721271393643031, 0.5721271393643031]
 [0.5326251896813354, 0.5326251896813354, 0.5326251896813354, 0.5326251896813354, 0.5326251896813354]
 ```
 
 ```jldoctest
+julia> using SpectralIndices
 julia> compute_index(["NDVI", "SAVI"]; N=0.643, R=0.175, L=0.5)
 0.5721271393643031
 0.5326251896813354
 ```
 
 ```jldoctest
+julia> using SpectralIndices
 julia> compute_index(
            ["NDVI", "SAVI"]; N=fill(0.643, (5, 5)), R=fill(0.175, (5, 5)), L=fill(0.5, (5, 5))
        )