diff --git a/docs/src/index.md b/docs/src/index.md index fa3a847..e67d849 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -2,6 +2,9 @@ EditURL = "https://github.com/JuliaIO/Tar.jl/blob/master/docs/src/index.md" ``` +The `Tar` module provides a simple interface for handling tar archives, including creation of +archives, extraction of selected files from an archive, and access to metadata. + # Tar ```@docs diff --git a/src/Tar.jl b/src/Tar.jl index f0d821f..73bc159 100644 --- a/src/Tar.jl +++ b/src/Tar.jl @@ -1,3 +1,7 @@ +""" +The `Tar` module provides a simple interface for handling tar archives, including creation of +archives, extraction of selected files from an archive, and access to metadata. +""" module Tar import SHA diff --git a/test/runtests.jl b/test/runtests.jl index 2212b0e..878c6a2 100644 --- a/test/runtests.jl +++ b/test/runtests.jl @@ -1130,3 +1130,9 @@ end end end end + +if isdefined(Docs, :undocumented_names) # new in Julia 1.11 + @testset "Docstrings" begin + @test isempty(Docs.undocumented_names(Tar)) + end +end