From 1ba7a404cae80060b7a12b5b15b56f3507fb03ec Mon Sep 17 00:00:00 2001 From: Hanno Braun Date: Wed, 24 Aug 2022 11:07:55 +0200 Subject: [PATCH 1/3] Remove obsolete paragraph from doc comment --- crates/fj-host/src/lib.rs | 4 ---- 1 file changed, 4 deletions(-) diff --git a/crates/fj-host/src/lib.rs b/crates/fj-host/src/lib.rs index f13f331469..d1ca49d27a 100644 --- a/crates/fj-host/src/lib.rs +++ b/crates/fj-host/src/lib.rs @@ -46,10 +46,6 @@ pub struct Model { impl Model { /// Initialize the model using the path to its crate (i.e. the folder /// containing `Cargo.toml`). - /// - /// Optionally, the target directory where plugin files are compiled to can - /// be provided. If it is not provided, the target directory is assumed to - /// be located within the model path. pub fn from_path(path: PathBuf) -> Result { let crate_dir = path.canonicalize()?; From 8c97ee056566d2fbf776a735551dde28fc5a0e5e Mon Sep 17 00:00:00 2001 From: Hanno Braun Date: Wed, 24 Aug 2022 11:08:49 +0200 Subject: [PATCH 2/3] Update doc comment --- crates/fj-host/src/lib.rs | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/crates/fj-host/src/lib.rs b/crates/fj-host/src/lib.rs index d1ca49d27a..e79bd9bcca 100644 --- a/crates/fj-host/src/lib.rs +++ b/crates/fj-host/src/lib.rs @@ -44,8 +44,10 @@ pub struct Model { } impl Model { - /// Initialize the model using the path to its crate (i.e. the folder - /// containing `Cargo.toml`). + /// Initialize the model using the path to its crate + /// + /// The path expected here is the root directory of the model's Cargo + /// package, that is the folder containing `Cargo.toml`. pub fn from_path(path: PathBuf) -> Result { let crate_dir = path.canonicalize()?; From c64f94d2d4b310c3caafb26db150167a5dee1259 Mon Sep 17 00:00:00 2001 From: Hanno Braun Date: Wed, 24 Aug 2022 11:27:45 +0200 Subject: [PATCH 3/3] Update obsolete comment --- crates/fj-host/src/lib.rs | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/crates/fj-host/src/lib.rs b/crates/fj-host/src/lib.rs index e79bd9bcca..f3d3847bf7 100644 --- a/crates/fj-host/src/lib.rs +++ b/crates/fj-host/src/lib.rs @@ -313,9 +313,9 @@ impl Watcher { { Ok(shape) => shape, Err(Error::Compile) => { - // It would be better to display an error in the UI, - // where the user can actually see it. Issue: - // https://github.com/hannobraun/fornjot/issues/30 + // An error is being displayed to the user via the + // `StatusReport that is passed to `load_once` above, so + // no need to do anything else here. return None; } Err(err) => {