-
-
Notifications
You must be signed in to change notification settings - Fork 143
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.
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
Improve haddock of Graphics.Implicit #287
Conversation
It's implemented as 'error', so no sense in exposing it.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Perfect. looks nice.
This is awesome, thanks for adding so much documentation! I'm pretty sure rotation is in degrees, though, not radians. You can test with Also, I'm not convined it's fair to say that the distance unit is universally millimeters; in the STL and SVG, for example, the output is at native, unspecified scale. |
@raptortech-js interesting. I've been using rads in all of my models, and things seem to work out. 45 is a bad test number I think, because Indeed, the code seems to agree that it's in rads:
where the You make an excellent point about the distances. My major point of confusion going through this was wondering if the rounding numbers were normalized to |
you're right, I should have tested more carefully! I brought it up because in my use case, I had noticed that |
😱 I spent a few hours yesterday attempting to quickspec this library. Sounds like a high-value thing to throw more time into! |
This PR documents most of the top-level functions, insofar as I could figure out what they do. The argument descriptions were deduced from their names in
Graphics.Implicit.ObjectUtil.GetImplicit3
, but could use a second pair of eyes.In addition, this PR fixes up some of the weird whitespace across the codebase (some trailing spaces, and a few intermingling tabs).
Potentially breaking change: I've stopped exporting
extrudeRotateR
, since as @raptortech-js pointed out, it's implemented aserror
and as such has no business existing.Additionally: I've now exported the
Object
class, giving haddock users some indication of what types on which they can usetranslate
et al. Also,R2' and
R3` are now exported.