Skip to content

Commit

Permalink
Add docstring for TOML stdlib module (#52834)
Browse files Browse the repository at this point in the history
  • Loading branch information
jam-khan authored Jan 15, 2024
1 parent fc6295d commit 89710bf
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 3 deletions.
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

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

0 comments on commit 89710bf

Please sign in to comment.