Skip to content

Commit 0b2b263

Browse files
authored
updated python doc strings (elalish#488)
* updated doc strings * pymanifold -> manifold3d
1 parent 2eb900b commit 0b2b263

9 files changed

+182
-83
lines changed

README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ node test/manifold_test.js
9898

9999
### Python
100100

101-
The CMake script will build the python binding `pymanifold` automatically. To
101+
The CMake script will build the python binding `manifold3d` automatically. To
102102
use the extension, please add `$BUILD_DIR/tools` to your `PYTHONPATH`, where
103103
`$BUILD_DIR` is the build directory for CMake. Examples using the python binding
104104
can be found in `bindings/python/examples`. To see exported samples, run:
@@ -112,8 +112,8 @@ Run the following code in the interpreter for
112112
python binding documentation:
113113

114114
```
115-
>>> import pymanifold
116-
>>> help(pymanifold)
115+
>>> import manifold3d
116+
>>> help(manifold3d)
117117
```
118118

119119
For more detailed documentation, please refer to the C++ API.

bindings/python/CMakeLists.txt

+5-5
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,10 @@
1515
project(python)
1616

1717
add_subdirectory(third_party)
18-
pybind11_add_module(pymanifold pymanifold.cpp)
19-
target_link_libraries(pymanifold PRIVATE manifold)
20-
target_compile_options(pymanifold PRIVATE ${MANIFOLD_FLAGS})
21-
target_compile_features(pymanifold PUBLIC cxx_std_17)
22-
target_include_directories(pymanifold
18+
pybind11_add_module(manifold3d manifold3d.cpp)
19+
target_link_libraries(manifold3d PRIVATE manifold)
20+
target_compile_options(manifold3d PRIVATE ${MANIFOLD_FLAGS})
21+
target_compile_features(manifold3d PUBLIC cxx_std_17)
22+
target_include_directories(manifold3d
2323
PRIVATE ${PYBIND11_DIR}/include
2424
)

bindings/python/examples/bricks.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
limitations under the License.
1515
"""
1616

17-
from pymanifold import Manifold
17+
from manifold3d import Manifold
1818

1919
# https://gist.github.com/deckar01/ef11def51de7e71d9f288c6e5819fdb7
2020

bindings/python/examples/cube_with_dents.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
limitations under the License.
1515
"""
1616

17-
from pymanifold import Manifold
17+
from manifold3d import Manifold
1818
from functools import reduce
1919

2020
# https://gist.github.com/ochafik/2db96400e3c1f73558fcede990b8a355#file-cube-with-half-spheres-dents-scad

bindings/python/examples/extrude.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
from pymanifold import CrossSection, FillRule
1+
from manifold3d import CrossSection, FillRule
22

33

44
def run():

bindings/python/examples/maze.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# One of the benchmarks in in https://gist.github.com/ochafik/2db96400e3c1f73558fcede990b8a355
22
# https://www.thingiverse.com/groups/openscad/forums/general/topic:34699
33

4-
from pymanifold import Manifold
4+
from manifold3d import Manifold
55
import numpy as np
66

77
n = 10

bindings/python/examples/union_failure.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
from pymanifold import Manifold
1+
from manifold3d import Manifold
22

33
def run():
44
# for some reason this causes collider error

bindings/python/pymanifold.cpp bindings/python/manifold3d.cpp

+168-69
Large diffs are not rendered by default.

flake.nix

+1-1
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@
4343
mkdir -p $out
4444
cp src/manifold/libmanifold.a $out/
4545
cp extras/perfTest $out
46-
cp bindings/python/pymanifold* $out
46+
cp bindings/python/manifold3d* $out
4747
'';
4848
};
4949
parallelBackends = [

0 commit comments

Comments
 (0)