@@ -19,7 +19,6 @@ def parse(script_source):
19
19
20
20
:param script_source: the script to run. Must be a valid cadquery script
21
21
:return: a CQModel object that defines the script and allows execution
22
-
23
22
"""
24
23
model = CQModel (script_source )
25
24
return model
@@ -39,6 +38,7 @@ class CQModel(object):
39
38
def __init__ (self , script_source ):
40
39
"""
41
40
Create an object by parsing the supplied python script.
41
+
42
42
:param script_source: a python script to parse
43
43
"""
44
44
self .metadata = ScriptMetadata ()
@@ -76,6 +76,7 @@ def validate(self, params):
76
76
"""
77
77
Determine if the supplied parameters are valid.
78
78
NOT IMPLEMENTED YET-- raises NotImplementedError
79
+
79
80
:param params: a dictionary of parameters
80
81
81
82
"""
@@ -84,14 +85,15 @@ def validate(self, params):
84
85
def build (self , build_parameters = None , build_options = None ):
85
86
"""
86
87
Executes the script, using the optional parameters to override those in the model
88
+
87
89
:param build_parameters: a dictionary of variables. The variables must be
88
- assignable to the underlying variable type. These variables override default values in the script
90
+ assignable to the underlying variable type. These variables override default values in the script
89
91
:param build_options: build options for how to build the model. Build options include things like
90
- timeouts, tessellation tolerances, etc
92
+ timeouts, tessellation tolerances, etc
91
93
:raises: Nothing. If there is an exception, it will be on the exception property of the result.
92
- This is the interface so that we can return other information on the result, such as the build time
94
+ This is the interface so that we can return other information on the result, such as the build time
93
95
:return: a BuildResult object, which includes the status of the result, and either
94
- a resulting shape or an exception
96
+ a resulting shape or an exception
95
97
"""
96
98
if not build_parameters :
97
99
build_parameters = {}
@@ -326,7 +328,8 @@ def __init__(self):
326
328
327
329
def show_object (self , shape , options = {}, ** kwargs ):
328
330
"""
329
- return an object to the executing environment, with options
331
+ Return an object to the executing environment, with options.
332
+
330
333
:param shape: a cadquery object
331
334
:param options: a dictionary of options that will be made available to the executing environment
332
335
"""
0 commit comments