From d52bbf43919777f19d92a394cc1540dcf341238e Mon Sep 17 00:00:00 2001 From: jam-khan Date: Tue, 9 Jan 2024 22:33:43 -0500 Subject: [PATCH 1/7] Added a docstring for TOML --- base/toml_parser.jl | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/base/toml_parser.jl b/base/toml_parser.jl index 086b7d99580c0..ea724ac685812 100644 --- a/base/toml_parser.jl +++ b/base/toml_parser.jl @@ -1,5 +1,11 @@ # 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. The module is designed to +handle exceptions, offers both regular and try-parse methods for development. +""" module TOML using Base: IdSet From 7a293160cc58b6d3f9c4c639a689b02b57cad5fd Mon Sep 17 00:00:00 2001 From: "Steven G. Johnson" Date: Wed, 10 Jan 2024 08:38:03 -0500 Subject: [PATCH 2/7] Update base/toml_parser.jl --- base/toml_parser.jl | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/base/toml_parser.jl b/base/toml_parser.jl index ea724ac685812..c82dcb34ef866 100644 --- a/base/toml_parser.jl +++ b/base/toml_parser.jl @@ -3,8 +3,7 @@ """ 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. The module is designed to -handle exceptions, offers both regular and try-parse methods for development. +and to serialize Julia data structures to TOML format. """ module TOML From 3755c6f32eea4895cb18953d87fe3f8ddc51308e Mon Sep 17 00:00:00 2001 From: jam-khan Date: Sat, 13 Jan 2024 09:16:59 -0500 Subject: [PATCH 3/7] Docstrings for TOML module placed in TOML.jl --- base/docs/temp.cpp | 0 base/toml_parser.jl | 6 ------ stdlib/TOML/src/TOML.jl | 6 ++++++ 3 files changed, 6 insertions(+), 6 deletions(-) create mode 100644 base/docs/temp.cpp diff --git a/base/docs/temp.cpp b/base/docs/temp.cpp new file mode 100644 index 0000000000000..e69de29bb2d1d diff --git a/base/toml_parser.jl b/base/toml_parser.jl index ea724ac685812..086b7d99580c0 100644 --- a/base/toml_parser.jl +++ b/base/toml_parser.jl @@ -1,11 +1,5 @@ # 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. The module is designed to -handle exceptions, offers both regular and try-parse methods for development. -""" module TOML using Base: IdSet diff --git a/stdlib/TOML/src/TOML.jl b/stdlib/TOML/src/TOML.jl index a2ea1869b4079..b55a5c7d04578 100644 --- a/stdlib/TOML/src/TOML.jl +++ b/stdlib/TOML/src/TOML.jl @@ -1,5 +1,11 @@ # 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 From cded906abb63855187a796eb30a564251469b437 Mon Sep 17 00:00:00 2001 From: jam-khan Date: Sat, 13 Jan 2024 09:23:48 -0500 Subject: [PATCH 4/7] Added Docstring for toml_parser.jl --- base/toml_parser.jl | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/base/toml_parser.jl b/base/toml_parser.jl index 086b7d99580c0..224d9b87565ed 100644 --- a/base/toml_parser.jl +++ b/base/toml_parser.jl @@ -1,5 +1,9 @@ # This file is a part of Julia. License is MIT: https://julialang.org/license +""" +`Base.TOML` is an internal, undocumented TOML parser; +users should call the TOML.jl standard library instead. +""" module TOML using Base: IdSet From fc96076b9c640686504ebc88b174e04dfdd97f44 Mon Sep 17 00:00:00 2001 From: jam-khan Date: Sat, 13 Jan 2024 10:28:34 -0500 Subject: [PATCH 5/7] Update base/toml_parser.jl Improved Docstring Co-authored-by: Steven G. Johnson --- base/toml_parser.jl | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/base/toml_parser.jl b/base/toml_parser.jl index 224d9b87565ed..eb7ffda2f5940 100644 --- a/base/toml_parser.jl +++ b/base/toml_parser.jl @@ -1,8 +1,9 @@ # This file is a part of Julia. License is MIT: https://julialang.org/license """ -`Base.TOML` is an internal, undocumented TOML parser; -users should call the TOML.jl standard library instead. +`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 From e45cd8ebdf2297577b0304a5ea84591de2ee4676 Mon Sep 17 00:00:00 2001 From: jam-khan Date: Sat, 13 Jan 2024 13:27:42 -0500 Subject: [PATCH 6/7] Fixed Blank line --- stdlib/TOML/src/TOML.jl | 1 - 1 file changed, 1 deletion(-) diff --git a/stdlib/TOML/src/TOML.jl b/stdlib/TOML/src/TOML.jl index b55a5c7d04578..a94eb926f8b88 100644 --- a/stdlib/TOML/src/TOML.jl +++ b/stdlib/TOML/src/TOML.jl @@ -5,7 +5,6 @@ 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 From a6be2292b0f7f6eedc12f43b48971dff10295659 Mon Sep 17 00:00:00 2001 From: jam-khan Date: Mon, 15 Jan 2024 09:26:31 -0500 Subject: [PATCH 7/7] Updated runtests.jl for TOML module --- stdlib/TOML/test/runtests.jl | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/stdlib/TOML/test/runtests.jl b/stdlib/TOML/test/runtests.jl index e471068f36e7f..47c762d054711 100644 --- 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