Add docstring for TOML stdlib module (JuliaLang#52834)

lazarusA · Jan 15, 2024 · 89710bf · 89710bf
1 parent fc6295d
commit 89710bf
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 3 deletions.
diff --git a/base/docs/temp.cpp b/base/docs/temp.cpp
diff --git a/base/toml_parser.jl b/base/toml_parser.jl
@@ -1,5 +1,10 @@
 # This file is a part of Julia. License is MIT: https://julialang.org/license
 
+"""
+`Base.TOML` is an undocumented internal part of Julia's TOML parser
+implementation. Users should call the the documented interface in the
+TOML.jl standard library instead (by `import TOML` or `using TOML`).
+"""
 module TOML
 
 using Base: IdSet

diff --git a/stdlib/TOML/src/TOML.jl b/stdlib/TOML/src/TOML.jl
@@ -1,5 +1,10 @@
 # This file is a part of Julia. License is MIT: https://julialang.org/license
 
+"""
+TOML.jl is a Julia standard library for parsing and writing TOML v1.0 files.
+This module provides functions to parse TOML strings and files into Julia data structures
+and to serialize Julia data structures to TOML format.
+"""
 module TOML
 
 module Internals

diff --git a/stdlib/TOML/test/runtests.jl b/stdlib/TOML/test/runtests.jl
@@ -27,7 +27,5 @@ include("parse.jl")
 @inferred TOML.parse("foo = 3")
 
 @testset "Docstrings" begin
- undoc = Docs.undocumented_names(TOML)
- @test_broken isempty(undoc)
- @test undoc == [:TOML]
+ @test isempty(Docs.undocumented_names(TOML))
 end