Skip to content

Commit 6c468bb

Browse files
committed
docs: final tweaks to readme and such before next prerelease
1 parent e65d054 commit 6c468bb

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

src/lib.rs

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
11
//! `kdl` is a "document-oriented" parser and API for the [KDL Document
22
//! Language](https://kdl.dev), a node-based, human-friendly configuration and
3-
//! serialization format. Unlike serde-based implementations, this crate
4-
//! preserves formatting when editing, as well as when inserting or changing
5-
//! values with custom formatting. This is most useful when working with
6-
//! human-maintained KDL files.
3+
//! serialization format.
4+
//!
5+
//! Unlike serde-based implementations, this crate preserves formatting when
6+
//! editing, as well as when inserting or changing values with custom
7+
//! formatting. This is most useful when working with human-maintained KDL
8+
//! files.
79
//!
810
//! You can think of this crate as
911
//! [`toml_edit`](https://crates.io/crates/toml_edit), but for KDL.
1012
//!
11-
//! If you don't care about formatting or programmatic manipulation, you might
12-
//! check out [`knuffel`](https://crates.io/crates/knuffel) or
13-
//! [`kaydle`](https://crates.io/crates/kaydle) instead for serde (or
14-
//! serde-like) parsing.
15-
//!
16-
//! This crate supports parsing [KDL
17-
//! 2.0.0-draft.6](https://github.com/kdl-org/kdl/releases/tag/2.0.0-draft.6)
13+
//! This crate supports parsing [the final KDL 2.0.0
14+
//! draft](https://github.com/kdl-org/kdl/pull/434), which might get a couple
15+
//! more small modifications before things are truly finalized. It does not
16+
//! support KDL 1.0 as of this release, but versions of this crate lower than
17+
//! 5.0 do.
1818
//!
1919
//! ## Example
2020
//!
@@ -107,7 +107,7 @@
107107
//! Multiple properties with the same name are allowed, and all duplicated
108108
//! **will be preserved**, meaning those documents will correctly round-trip.
109109
//! When using `node.get()`/`node["key"]` & company, the _last_ property with
110-
//! that name's value will be returned.
110+
//! that name's value will be returned (as per spec).
111111
//!
112112
//! ### Numbers
113113
//!
@@ -168,7 +168,7 @@
168168

169169
#![deny(missing_debug_implementations, nonstandard_style)]
170170
#![warn(missing_docs, rust_2018_idioms, unreachable_pub)]
171-
// #![cfg_attr(test, deny(warnings))]
171+
#![cfg_attr(test, deny(warnings))]
172172
#![doc(html_favicon_url = "https://kdl.dev/favicon.ico")]
173173
#![doc(html_logo_url = "https://kdl.dev/logo.svg")]
174174

0 commit comments

Comments
 (0)