Merge pull request #71 from JuliaGeometry/sjk/doc1

Doc Updates for v0.6

Project.toml

@@ -6,11 +6,13 @@ version = "0.6.0"
 julia = "0.7, 1"
 
 [extras]
+Aqua = "4c88cf16-eb10-579e-8560-4a9242c79595"
+JET = "c3a54625-cd67-489e-a8e7-0a5a0ff4e31b"
 LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
 OffsetArrays = "6fe1bfb0-de20-5000-8ca7-80f57d26f881"
 StaticArrays = "90137ffa-7385-5640-81b9-e52037218182"
 StatsBase = "2913bbd2-ae8a-5f71-8c99-4fb6c76f3a91"
 Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
 
 [targets]
-test = ["LinearAlgebra", "StatsBase", "Test", "OffsetArrays", "StaticArrays"]
+test = ["Aqua", "JET", "LinearAlgebra", "StatsBase", "Test", "OffsetArrays", "StaticArrays"]

src/Contour.jl

@@ -14,6 +14,11 @@ export
 
 import Base: push!, length, eltype, show
 
+"""
+    Curve2{T}
+
+Containing an extracted chain of points, where `T` is a vector-like element.
+"""
 struct Curve2{T}
     vertices::Vector{T}
 end
@@ -54,8 +59,11 @@ contour levels. Each of the objects support [`level`](@ref) and
 levels(cc::ContourCollection) = cc.contours
 
 """
-`contour(x, y, z, level::Number)` Trace a single contour level, indicated by the
-argument `level`.
+    contour(x, y, z, level::Number)
+    contour(x, y, z, level::Number, VT::Type)
+
+Trace a single contour level, indicated by the argument `level`. The extracted vertex type
+maybe be specified by `VT`.
 
 You'll usually call [`lines`](@ref) on the output of `contour`, and then iterate
 over the result.
@@ -73,7 +81,7 @@ end
 
 You'll usually call [`levels`](@ref) on the output of `contours`.
 """
-contours(::Any...) = error("This method exists only for documentation purposes")
+function contours end
 
 """
 `contours(x,y,z,levels)` Trace the contour levels indicated by the `levels`

test/runtests.jl

@@ -8,3 +8,17 @@ include("interface.jl")
 
 #issue 59
 @inferred collect(())
+
+using Aqua
+# Aqua tests
+# Intervals brings a bunch of ambiquities unfortunately
+Aqua.test_all(Contour)
+
+
+@static if Base.VERSION >= v"1.7"
+
+    @info "Running JET..."
+
+    using JET
+    display(JET.report_package(Contour))
+end