Added docstring for Artifacts.jl (JuliaLang#52913)

This is a part of issue JuliaLang#52725. --------- Co-authored-by: Steven G. Johnson <[email protected]> Co-authored-by: Max Horn <[email protected]>
DilumAluthgeBot · Feb 8, 2024 · 15e2af2 · 15e2af2
1 parent c5ad467
commit 15e2af2
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 3 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
@@ -263,7 +263,5 @@ end
 end
 
 @testset "Docstrings" begin
-    undoc = Docs.undocumented_names(Artifacts)
-    @test_broken isempty(undoc)
-    @test undoc == [:Artifacts]
+    @test isempty(Docs.undocumented_names(Artifacts))
 end