Skip to content

Commit 08cd1a5

Browse files
jam-khanstevengjfingolfin
authored andcommitted
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)
1 parent feceefe commit 08cd1a5

File tree

2 files changed

+10
-0
lines changed

2 files changed

+10
-0
lines changed

stdlib/Artifacts/src/Artifacts.jl

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
# This file is a part of Julia. License is MIT: https://julialang.org/license
22

3+
"""
4+
Artifacts.jl is a Julia module that is used for managing and accessing
5+
artifacts in Julia packages. Artifacts are containers for
6+
platform-specific binaries, datasets, text, or any other kind of data
7+
that would be convenient to place within an immutable, life-cycled datastore.
8+
"""
39
module Artifacts
410

511
import Base: get, SHA1

stdlib/Artifacts/test/runtests.jl

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -164,3 +164,7 @@ end
164164
@test length(Base.manifest_names) == n
165165
@test length(Base.preferences_names) == n
166166
end
167+
168+
@testset "Docstrings" begin
169+
@test isempty(Docs.undocumented_names(Artifacts))
170+
end

0 commit comments

Comments
 (0)