From b6a7a9c1f003a4320850d67f5e7bd874361c120e Mon Sep 17 00:00:00 2001 From: Hanno Braun Date: Fri, 28 Jan 2022 15:40:01 +0100 Subject: [PATCH 1/2] Improve wording --- fj/src/shape_3d.rs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/fj/src/shape_3d.rs b/fj/src/shape_3d.rs index 65b9f947d..594e9a0aa 100644 --- a/fj/src/shape_3d.rs +++ b/fj/src/shape_3d.rs @@ -28,7 +28,7 @@ impl From for Shape { /// # Limitations /// /// This operation is not supported right now. Using it in a model, will result -/// in the host application to crash. +/// in the host application crashing. #[derive(Clone, Debug)] #[repr(C)] pub struct Difference { From 09aaf9149b6f7fbe4c2ed3d30bd034ca4879be31 Mon Sep 17 00:00:00 2001 From: Hanno Braun Date: Fri, 28 Jan 2022 15:41:54 +0100 Subject: [PATCH 2/2] Link issues, where limitations are documented --- fj/src/shape_3d.rs | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/fj/src/shape_3d.rs b/fj/src/shape_3d.rs index 594e9a0aa..b974890b1 100644 --- a/fj/src/shape_3d.rs +++ b/fj/src/shape_3d.rs @@ -29,6 +29,9 @@ impl From for Shape { /// /// This operation is not supported right now. Using it in a model, will result /// in the host application crashing. +/// +/// See issue: +/// https://github.com/hannobraun/Fornjot/issues/43 #[derive(Clone, Debug)] #[repr(C)] pub struct Difference { @@ -57,6 +60,9 @@ impl From for Shape3d { /// /// Transformations are currently limited to a rotation, followed by a /// translation. +/// +/// See issue: +/// https://github.com/hannobraun/Fornjot/issues/101 #[derive(Clone, Debug)] #[repr(C)] pub struct Transform { @@ -119,6 +125,9 @@ impl From for Shape3d { /// This means, for example, that generating the triangle mesh of the union does /// not result in a proper triangle mesh, but rather the two, possibly /// intersecting, triangle meshes of the original shapes. +/// +/// See issue: +/// https://github.com/hannobraun/Fornjot/issues/42 #[derive(Clone, Debug)] #[repr(C)] pub struct Union {