extern/nushell
1
0
Fork 1
mirror of https://github.com/nushell/nushell.git synced 2025-08-09 08:26:22 +02:00
Code Issues Packages Projects Releases Wiki Activity

improve NUON documentation (#12717)

Browse Source 
# 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
This commit is contained in:
Antoine Stevan
2024-05-05 15:34:22 +02:00
committed by GitHub
parent 2f8e397365
commit ce3bc470ba
4 changed files with 42 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
crates/nuon/src/lib.rs
View File

@ -1,9 +1,4 @@
//! 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
//! - quotes are not required around keys
#![doc = include_str!("../README.md")]
mod from;
mod to;