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.

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

updated python doc strings #488

Merged
merged 2 commits into from
Jul 13, 2023
Merged

updated python doc strings #488

merged 2 commits into from
Jul 13, 2023

Conversation

elalish
Copy link
Owner

@elalish elalish commented Jul 13, 2023

Fixes some more of #361, but I'd still like to get a MeshGL binding in before we publish to pypi.

@elalish elalish requested a review from pca006132 July 13, 2023 05:27
@elalish elalish self-assigned this Jul 13, 2023
@pca006132
Copy link
Collaborator

It seems that we should also change the name of pymanifold.cpp to manifold3d.cpp, or there will be weird import errors. Otherwise this looks good to me.

@elalish
Copy link
Owner Author

elalish commented Jul 13, 2023

Good call, thanks!

@codecov
Copy link

codecov bot commented Jul 13, 2023

Codecov Report

Patch coverage has no change and project coverage change: +0.03 🎉

Comparison is base (ba5fead) 90.31% compared to head (c789a2b) 90.35%.

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #488      +/-   ##
==========================================
+ Coverage   90.31%   90.35%   +0.03%     
==========================================
  Files          35       35              
  Lines        4389     4396       +7     
==========================================
+ Hits         3964     3972       +8     
+ Misses        425      424       -1     

see 2 files with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

@elalish elalish merged commit 8b7bf42 into master Jul 13, 2023
@elalish elalish deleted the pythonCleanup branch July 13, 2023 18:34
@axel-angel
Copy link
Contributor

aaa breaking change 😅

It seems that we should also change the name of pymanifold.cpp to manifold3d.cpp, or there will be weird import errors. Otherwise this looks good to me.

it's probably obvious but can you explain?

@pca006132
Copy link
Collaborator

@axel-angel This is because we want to use the same name across NPM and PyPi later, so we want to change the module name. Changing the module name also require changing the filename due to how python works.

@elalish
Copy link
Owner Author

elalish commented Jul 15, 2023

Exactly, I'm trying to get our breaking changes out of the way before doing our first pypi release.

@elalish elalish mentioned this pull request Nov 3, 2023
cartesian-theatrics pushed a commit to SovereignShop/manifold that referenced this pull request Mar 11, 2024
* updated doc strings

* pymanifold -> manifold3d
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.

3 participants