Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add docstring for TOML stdlib module #52834

Merged
merged 11 commits into from
Jan 15, 2024
Empty file added base/docs/temp.cpp
Empty file.
5 changes: 5 additions & 0 deletions base/toml_parser.jl
Original file line number Diff line number Diff line change
@@ -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
stevengj marked this conversation as resolved.
Show resolved Hide resolved

using Base: IdSet
Expand Down
5 changes: 5 additions & 0 deletions stdlib/TOML/src/TOML.jl
Original file line number Diff line number Diff line change
@@ -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
Expand Down
4 changes: 1 addition & 3 deletions stdlib/TOML/test/runtests.jl
Original file line number Diff line number Diff line change
Expand Up @@ -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