summaryrefslogtreecommitdiff
path: root/dhall/src
diff options
context:
space:
mode:
authorNadrieril2019-04-13 00:57:01 +0200
committerNadrieril2019-04-13 00:57:01 +0200
commit5e41c4d1de45e2c799a1471692a715da565387e0 (patch)
treede7abe9dcbea80ebbd72277f8733f01537949e1d /dhall/src
parente7e79bf32c385fa8c30a45be262ca3d6d8f1f653 (diff)
docs: document import resolution root
Diffstat (limited to 'dhall/src')
-rw-r--r--dhall/src/lib.rs10
1 files changed, 6 insertions, 4 deletions
diff --git a/dhall/src/lib.rs b/dhall/src/lib.rs
index 51fb6b7..91e3f6a 100644
--- a/dhall/src/lib.rs
+++ b/dhall/src/lib.rs
@@ -138,8 +138,9 @@ mod serde;
/// Deserialize an instance of type T from a string of Dhall text.
///
/// This will recursively resolve all imports in the expression, and
-/// typecheck it. More control over this process is not yet available
-/// but will be in a coming verions of this crate.
+/// typecheck it before deserialization. Relative imports will be resolved relative to the
+/// provided file. More control over this process is not yet available
+/// but will be in a coming version of this crate.
///
/// If a type is provided, this additionally checks that the provided
/// expression has that type.
@@ -154,8 +155,9 @@ pub fn from_str<'a, T: Deserialize<'a>>(
/// additionally checking that it matches the type of T.
///
/// This will recursively resolve all imports in the expression, and
-/// typecheck it. More control over this process is not yet available
-/// but will be in a coming verions of this crate.
+/// typecheck it before deserialization. Relative imports will be resolved relative to the
+/// provided file. More control over this process is not yet available
+/// but will be in a coming version of this crate.
pub fn from_str_auto_type<'a, T: Deserialize<'a> + StaticType>(
s: &'a str,
) -> crate::error::Result<T> {