1
0
Fork 0
mirror of synced 2025-09-23 20:28:36 +00:00

improve doc

This commit is contained in:
schaeff 2020-02-17 19:45:31 +01:00
parent 3b2f3909f4
commit 537cfd1554

View file

@ -19,11 +19,15 @@ type SourceCode = String;
/// * `current_location` - Path to the file we're importing into
/// * `import_location` - Path to the file we're importing from
///
/// # Returns
/// * The content of the file we're importing from
/// * The path to the file we're importing from
///
/// # Remarks
///
/// * `current_location* must point to a file
/// * `import_location` is relative to the directory in which `current_location` is, unless it's an absolute
/// path, in which case it's relative to the root of the ZoKrates stdlib at `$ZOKRATES_HOME`
/// * `import_location` and the returned path are both relative to the directory in which `current_location` is, unless it's an absolute
/// path, in which case they are relative to the root of the ZoKrates stdlib at `$ZOKRATES_HOME`
///
pub fn resolve<'a>(
current_location: CurrentLocation,