ManifoldCAD docs update #446
Conversation
|
Seems like an easy way to quasi-deprecate those functions being at the top-level. Is the goal to eventually drop these out of the top-level again? If so do you think a notice with a timeline to removal would be necessary, or just give people some time with the annoying red squigglies? |
This reverts commit 5f102e5.
|
Interesting, why is there redefinition error? Can you show the error message and the exact location throwing the error? (too lazy to turn on my computer) |
Codecov ReportPatch and project coverage have no change.
Additional details and impacted files@@ Coverage Diff @@
## master #446 +/- ##
=======================================
Coverage 89.67% 89.67%
=======================================
Files 35 35
Lines 4243 4243
=======================================
Hits 3805 3805
Misses 438 438 ☔ View full report in Codecov by Sentry. |
|
It's because we now want to use the pattern e.g. |
|
I think people will be able to figure it out. Pretty quick fix to add one line at the top to cover all of the used constructors as well. |
* fix back compat * updated docs * Revert "fix back compat" This reverts commit 5f102e5.
We made a breaking change in #440 to pull the static methods up into
module.Manifold, which I think is the right call, but this breaks people's existing scripts in ManifoldCAD.org.I decided to add back in the bare manifold constructors so that those scripts will still run, though I did not add them back into theNevermind, I should have tested first. This isn't an option because we get redefinition errors. Now I'm just updating the intro docs..d.ts. This means they get a red error telling them to update while their script still runs - this feels like a reasonable compromise for now.