Added docstring for Artifacts.jl (#52913)

This is a part of issue #52725. --------- Co-authored-by: Steven G. Johnson <stevenj@mit.edu> Co-authored-by: Max Horn <max@quendi.de> (cherry picked from commit 15e2af2)
JuliaLang · Apr 11, 2024 · 08cd1a5 · 08cd1a5
1 parent feceefe
commit 08cd1a5
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git a/stdlib/Artifacts/src/Artifacts.jl b/stdlib/Artifacts/src/Artifacts.jl
@@ -1,5 +1,11 @@
 # This file is a part of Julia. License is MIT: https://julialang.org/license
 
+"""
+Artifacts.jl is a Julia module that is used for managing and accessing
+artifacts in Julia packages. Artifacts are containers for
+platform-specific binaries, datasets, text, or any other kind of data
+that would be convenient to place within an immutable, life-cycled datastore.
+"""
 module Artifacts
 
 import Base: get, SHA1

diff --git a/stdlib/Artifacts/test/runtests.jl b/stdlib/Artifacts/test/runtests.jl
@@ -164,3 +164,7 @@ end
     @test length(Base.manifest_names) == n
     @test length(Base.preferences_names) == n
 end
+
+@testset "Docstrings" begin
+    @test isempty(Docs.undocumented_names(Artifacts))
+end