Skip to content

Commit 89710bf

Browse files
authored
Add docstring for TOML stdlib module (#52834)
1 parent fc6295d commit 89710bf

File tree

4 files changed

+11
-3
lines changed

4 files changed

+11
-3
lines changed

base/docs/temp.cpp

Whitespace-only changes.

base/toml_parser.jl

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

3+
"""
4+
`Base.TOML` is an undocumented internal part of Julia's TOML parser
5+
implementation. Users should call the the documented interface in the
6+
TOML.jl standard library instead (by `import TOML` or `using TOML`).
7+
"""
38
module TOML
49

510
using Base: IdSet

stdlib/TOML/src/TOML.jl

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

3+
"""
4+
TOML.jl is a Julia standard library for parsing and writing TOML v1.0 files.
5+
This module provides functions to parse TOML strings and files into Julia data structures
6+
and to serialize Julia data structures to TOML format.
7+
"""
38
module TOML
49

510
module Internals

stdlib/TOML/test/runtests.jl

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,5 @@ include("parse.jl")
2727
@inferred TOML.parse("foo = 3")
2828

2929
@testset "Docstrings" begin
30-
undoc = Docs.undocumented_names(TOML)
31-
@test_broken isempty(undoc)
32-
@test undoc == [:TOML]
30+
@test isempty(Docs.undocumented_names(TOML))
3331
end

0 commit comments

Comments
 (0)