Skip to content

Commit 15e2af2

Browse files
jam-khanstevengjfingolfin
authored
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]>
1 parent c5ad467 commit 15e2af2

File tree

2 files changed

+7
-3
lines changed

2 files changed

+7
-3
lines changed

stdlib/Artifacts/src/Artifacts.jl

+6
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

+1-3
Original file line numberDiff line numberDiff line change
@@ -263,7 +263,5 @@ end
263263
end
264264

265265
@testset "Docstrings" begin
266-
undoc = Docs.undocumented_names(Artifacts)
267-
@test_broken isempty(undoc)
268-
@test undoc == [:Artifacts]
266+
@test isempty(Docs.undocumented_names(Artifacts))
269267
end

0 commit comments

Comments
 (0)