Skip to content

Commit

Permalink
[docs] keeps lib docs in sync with README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ordian committed Jul 6, 2019
1 parent 9dd1963 commit a4407f4
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@
//!
//! ## Limitations
//!
//! *Things it does not preserve:
//! Things it does not preserve:
//!
//! * Different quotes and spaces around the same table key, e.g.
//!
Expand All @@ -58,16 +58,17 @@
//! ['a'.d]
//! ```
//!
//! * Children tables before parent table (tables are reordered, see [test]).
//! * Scattered array of tables (tables are reordered, see [test]).
//! * Children tables before parent table (tables are reordered by default, see [test]).
//! * Scattered array of tables (tables are reordered by default, see [test]).
//!
//! The reason behind the first limitation is that `Table` does not store its header,
//! allowing us to safely swap two tables
//! (we store a mapping in each table: child key -> child table).
//!
//! This last two limitations allow us to represent a toml document as a tree-like data structure,
//! which enables easier implementation of editing operations
//! and an easy to use and type-safe API.
//! and an easy to use and type-safe API. If you care about the above two cases,
//! you can use `Document::to_string_in_original_order()` to reconstruct tables in their original order.
//!
//! [test]: https://github.com/ordian/toml_edit/blob/f09bd5d075fdb7d2ef8d9bb3270a34506c276753/tests/test_valid.rs#L84
Expand Down

0 comments on commit a4407f4

Please sign in to comment.