berkus
/
kdl-rs
mirror of https://github.com/kdl-org/kdl-rs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs: final tweaks to readme and such before next prerelease

This commit is contained in:
Kat Marchán 2024-12-15 18:17:04 -08:00
parent e65d0546bc
commit 6c468bb5d1
No known key found for this signature in database
GPG Key ID: AEB529C08A3C7E9E
1 changed files with 13 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
src/lib.rs
View File

@ -1,20 +1,20 @@
//! `kdl` is a "document-oriented" parser and API for the [KDL Document //! `kdl` is a "document-oriented" parser and API for the [KDL Document
//! Language](https://kdl.dev), a node-based, human-friendly configuration and //! Language](https://kdl.dev), a node-based, human-friendly configuration and
//! serialization format. Unlike serde-based implementations, this crate //! serialization format.
//! preserves formatting when editing, as well as when inserting or changing //!
//! values with custom formatting. This is most useful when working with //! Unlike serde-based implementations, this crate preserves formatting when
//! human-maintained KDL files. //! editing, as well as when inserting or changing values with custom
//! formatting. This is most useful when working with human-maintained KDL
//! files.
//! //!
//! You can think of this crate as //! You can think of this crate as
//! [`toml_edit`](https://crates.io/crates/toml_edit), but for KDL. //! [`toml_edit`](https://crates.io/crates/toml_edit), but for KDL.
//! //!
//! If you don't care about formatting or programmatic manipulation, you might //! This crate supports parsing [the final KDL 2.0.0
//! check out [`knuffel`](https://crates.io/crates/knuffel) or //! draft](https://github.com/kdl-org/kdl/pull/434), which might get a couple
//! [`kaydle`](https://crates.io/crates/kaydle) instead for serde (or //! more small modifications before things are truly finalized. It does not
//! serde-like) parsing. //! support KDL 1.0 as of this release, but versions of this crate lower than
//! //! 5.0 do.
//! This crate supports parsing [KDL
//! 2.0.0-draft.6](https://github.com/kdl-org/kdl/releases/tag/2.0.0-draft.6)
//! //!
//! ## Example //! ## Example
//! //!
@ -107,7 +107,7 @@
//! Multiple properties with the same name are allowed, and all duplicated //! Multiple properties with the same name are allowed, and all duplicated
//! **will be preserved**, meaning those documents will correctly round-trip. //! **will be preserved**, meaning those documents will correctly round-trip.
//! When using `node.get()`/`node["key"]` & company, the _last_ property with //! When using `node.get()`/`node["key"]` & company, the _last_ property with
//! that name's value will be returned. //! that name's value will be returned (as per spec).
//! //!
//! ### Numbers //! ### Numbers
//! //!
@ -168,7 +168,7 @@
#![deny(missing_debug_implementations, nonstandard_style)] #![deny(missing_debug_implementations, nonstandard_style)]
#![warn(missing_docs, rust_2018_idioms, unreachable_pub)] #![warn(missing_docs, rust_2018_idioms, unreachable_pub)]
// #![cfg_attr(test, deny(warnings))] #![cfg_attr(test, deny(warnings))]
#![doc(html_favicon_url = "https://kdl.dev/favicon.ico")] #![doc(html_favicon_url = "https://kdl.dev/favicon.ico")]
#![doc(html_logo_url = "https://kdl.dev/logo.svg")] #![doc(html_logo_url = "https://kdl.dev/logo.svg")]