Skip to content

Conversation

@gserena01
Copy link
Contributor

No description provided.

Comment on lines +133 to +136
/// If true, seams between the extrusion and the original body will be shown.
/// Otherwise, seams resulting from the extrusion will be removed where possible.
#[serde(default)]
pub merge_coplanar_faces: Option<bool>,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The field name merge_coplanar_faces contradicts its documented behavior. The name implies that when true, coplanar faces should be merged (hiding seams), but the documentation states "If true, seams between the extrusion and the original body will be shown." This semantic inversion will cause incorrect usage in production.

Fix: Either rename the field to match the behavior or fix the documentation:

// Option 1: Rename field to match documented behavior
pub show_seams: Option<bool>,

// Option 2: Fix documentation to match field name
/// If true, coplanar faces will be merged and seams will be hidden.
/// Otherwise, seams between the extrusion and original body will be shown.
pub merge_coplanar_faces: Option<bool>,
Suggested change
/// If true, seams between the extrusion and the original body will be shown.
/// Otherwise, seams resulting from the extrusion will be removed where possible.
#[serde(default)]
pub merge_coplanar_faces: Option<bool>,
/// If true, coplanar faces will be merged and seams will be hidden.
/// Otherwise, seams between the extrusion and original body will be shown.
#[serde(default)]
pub merge_coplanar_faces: Option<bool>,

Spotted by Graphite Agent

Fix in Graphite


Is this helpful? React 👍 or 👎 to let us know.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants