nushell/crates/nuon
Antoine Stevan ce3bc470ba
improve NUON documentation (#12717)
# Description
this PR
- moves the documentation from `lib.rs` to `README.md` while still
including it in the lib file, so that both the [crates.io
page](https://crates.io/crates/nuon) and the
[documentation](https://docs.rs/nuon/latest/nuon/) show the top-level
doc
- mention that comments are allowed in NUON
- add a JSON-NUON example
- put back the formatting of NOTE blocks in the doc

# User-Facing Changes

# Tests + Formatting

# After Submitting
2024-05-05 15:34:22 +02:00
..
src improve NUON documentation (#12717) 2024-05-05 15:34:22 +02:00
Cargo.toml Bump version to 0.93.1 (#12710) 2024-05-01 17:19:20 -05:00
LICENSE create nuon crate from from nuon and to nuon (#12553) 2024-04-19 13:54:16 +02:00
README.md improve NUON documentation (#12717) 2024-05-05 15:34:22 +02:00

Support for the NUON format.

The NUON format is a superset of JSON designed to fit the feel of Nushell. Some of its extra features are

  • trailing commas are allowed
  • commas are optional in lists
  • quotes are not required around keys or any bare string that do not contain spaces
  • comments are allowed, though not preserved when using [from_nuon]

Example

below is some data in the JSON format

{
    "name": "Some One",
    "birth": "1970-01-01",
    "stats": [
      2544729499973429198,
      687051042647753531,
      6702443901704799912
    ]
}

and an equivalent piece of data written in NUON

{
    name: "Some One",       # the name of the person
    birth: "1970-01-01",    # their date of birth
    stats: [                # some dummy "stats" about them
      2544729499973429198,
      687051042647753531,
      6702443901704799912, # note the trailing comma here...
    ], # and here
} # wait, are these comments in a JSON-like document?!?!