summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNadrieril2020-04-05 18:14:06 +0100
committerNadrieril2020-04-05 18:14:06 +0100
commit1f1ba51249df6f3ce739d4727e054d0893fd3288 (patch)
tree7a05991753ecf28369a5a1eac932191234e35901
parent7e977f282fb6a0eff0ef45738b9b5c98dc4c6fee (diff)
Doc tweaks
-rw-r--r--README.md7
-rw-r--r--serde_dhall/src/options.rs4
2 files changed, 10 insertions, 1 deletions
diff --git a/README.md b/README.md
index 1520b7d..11acb5a 100644
--- a/README.md
+++ b/README.md
@@ -169,7 +169,12 @@ same name as the corresponding test.
#### [???]
-- Breaking change: reworked most of the `serde_dhall` api
+- Add `serde_dhall::from_file` to read a Dhall file directly.
+- BREAKING CHANGE: reworked most of the `serde_dhall` API
+
+ You need to replace uses of `from_str(s)` with `from_str(s).parse()`. The
+ various type annotation methods have been removed; use instead the methods on
+ the `Deserializer` struct.
#### [0.4.0]
diff --git a/serde_dhall/src/options.rs b/serde_dhall/src/options.rs
index 06a4368..76b1c5b 100644
--- a/serde_dhall/src/options.rs
+++ b/serde_dhall/src/options.rs
@@ -302,6 +302,8 @@ impl<'a, A> Deserializer<'a, A> {
/// This returns a [`Deserializer`] object. Call the [`parse`] method to get the deserialized
/// value, or use other [`Deserializer`] methods to control the deserialization process.
///
+/// Imports will be resolved relative to the current directory.
+///
/// # Example
///
/// ```rust
@@ -338,6 +340,8 @@ pub fn from_str(s: &str) -> Deserializer<'_, NoAnnot> {
/// This returns a [`Deserializer`] object. Call the [`parse`] method to get the deserialized
/// value, or use other [`Deserializer`] methods to control the deserialization process.
///
+/// Imports will be resolved relative to the provided file's path.
+///
/// # Example
///
/// ```no_run