|
1 | 1 | //! `kdl` is a "document-oriented" parser and API for the [KDL Document
|
2 | 2 | //! 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. |
7 | 9 | //!
|
8 | 10 | //! You can think of this crate as
|
9 | 11 | //! [`toml_edit`](https://crates.io/crates/toml_edit), but for KDL.
|
10 | 12 | //!
|
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. |
18 | 18 | //!
|
19 | 19 | //! ## Example
|
20 | 20 | //!
|
|
107 | 107 | //! Multiple properties with the same name are allowed, and all duplicated
|
108 | 108 | //! **will be preserved**, meaning those documents will correctly round-trip.
|
109 | 109 | //! 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). |
111 | 111 | //!
|
112 | 112 | //! ### Numbers
|
113 | 113 | //!
|
|
168 | 168 |
|
169 | 169 | #![deny(missing_debug_implementations, nonstandard_style)]
|
170 | 170 | #![warn(missing_docs, rust_2018_idioms, unreachable_pub)]
|
171 |
| -// #![cfg_attr(test, deny(warnings))] |
| 171 | +#![cfg_attr(test, deny(warnings))] |
172 | 172 | #![doc(html_favicon_url = "https://kdl.dev/favicon.ico")]
|
173 | 173 | #![doc(html_logo_url = "https://kdl.dev/logo.svg")]
|
174 | 174 |
|
|
0 commit comments