Skip to content

Commit

Permalink
TOML.print: fix sort -> sorted and clarify that all tables are sorted. (
Browse files Browse the repository at this point in the history
  • Loading branch information
fredrikekre committed Sep 16, 2020
1 parent 8c07013 commit 8196ae3
Showing 1 changed file with 3 additions and 4 deletions.
7 changes: 3 additions & 4 deletions stdlib/TOML/src/TOML.jl
Original file line number Diff line number Diff line change
Expand Up @@ -100,11 +100,10 @@ const ParserError = Internals.ParserError


"""
print([to_toml::Function], io::IO [=stdout], data::AbstractDict; sort=false, by=identity)
print([to_toml::Function], io::IO [=stdout], data::AbstractDict; sorted=false, by=identity)
Writes `data` as TOML syntax to the stream `io`. The keyword argument `sort`
sorts the output on the keys of the tables with the top level tables are
sorted according to the keyword argument `by`.
Write `data` as TOML syntax to the stream `io`. If the keyword argument `sorted` is set to `true`,
sort tables according to the function given by the keyword argument `by`.
The following data types are supported: `AbstractDict`, `Integer`, `AbstractFloat`, `Bool`,
`Dates.DateTime`, `Dates.Time`, `Dates.Date`. Note that the integers and floats
Expand Down

0 comments on commit 8196ae3

Please sign in to comment.