[Chapel Merge] docs: update docs regarding TOML printing and sort

Notifications Commits
1

Branch: refs/heads/main
Revision: cc431e6
Author: arezaii
Link: docs: update docs regarding TOML printing and sorted tables/keys by arezaii · Pull Request #19476 · chapel-lang/chapel · GitHub
Log Message:

Merge pull request #19476 from arezaii/toml-docs

docs: update docs regarding TOML printing and sorted tables/keys

This PR adds a note to the TOML docs to indicate that the contents
will be printed in order.

  • the docs for TOML didn't indicate that printing a TOML object
    would result in a special sort order for the tables (root first)
    and then that the keys and all other tables would be sorted and then
    printed.

  • adjust the mason docs to show .toml files with sorted tables/keys
    according to the TOML printing logic.

Testing:

  • [x] manual review of the TOML and Mason docs

Reviewed by @dlongnecke-cray - thanks!

Signed-off-by: arezaii ahmad.rezaii@hpe.com

Modified Files:
M doc/rst/tools/mason/mason.rst

M modules/packages/TOML.chpl

Compare: https://github.com/chapel-lang/chapel/compare/223bc72a40e7...cc431e6c3465