Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make improvements to documentation of fj crate #106

Merged
merged 2 commits into from
Jan 28, 2022
+10 −1
Merged

Make improvements to documentation of fj crate #106

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b6a7a9c
Improve wording
hannobraun Jan 28, 2022
09aaf91
Link issues, where limitations are documented
hannobraun Jan 28, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion fj/src/shape_3d.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,10 @@ impl From<Shape3d> 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.
///
/// See issue:
/// https://github.com/hannobraun/Fornjot/issues/43
#[derive(Clone, Debug)]
#[repr(C)]
pub struct Difference {
Expand Down Expand Up @@ -57,6 +60,9 @@ impl From<Difference> 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 {
Expand Down Expand Up @@ -119,6 +125,9 @@ impl From<Sweep> 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 {
Expand Down