From 15e2af2c917fb6f343fc9973b3fc633e4b6efaea Mon Sep 17 00:00:00 2001 From: jam-khan Date: Thu, 8 Feb 2024 06:52:35 -0500 Subject: [PATCH] Added docstring for Artifacts.jl (#52913) This is a part of issue #52725. --------- Co-authored-by: Steven G. Johnson Co-authored-by: Max Horn --- stdlib/Artifacts/src/Artifacts.jl | 6 ++++++ stdlib/Artifacts/test/runtests.jl | 4 +--- 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/stdlib/Artifacts/src/Artifacts.jl b/stdlib/Artifacts/src/Artifacts.jl index b7db79b8ef6b4..968d190c2b443 100644 --- 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 index 2255930baf8e4..a09b3c7531996 100644 --- 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