Skip to content

Commit 79adadc

Browse files
committed
Fix rst syntax errors in cqgi.py
1 parent 4a79b31 commit 79adadc

File tree

1 file changed

+9
-6
lines changed

1 file changed

+9
-6
lines changed

cadquery/cqgi.py

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,6 @@ def parse(script_source):
1919
2020
:param script_source: the script to run. Must be a valid cadquery script
2121
:return: a CQModel object that defines the script and allows execution
22-
2322
"""
2423
model = CQModel(script_source)
2524
return model
@@ -39,6 +38,7 @@ class CQModel(object):
3938
def __init__(self, script_source):
4039
"""
4140
Create an object by parsing the supplied python script.
41+
4242
:param script_source: a python script to parse
4343
"""
4444
self.metadata = ScriptMetadata()
@@ -76,6 +76,7 @@ def validate(self, params):
7676
"""
7777
Determine if the supplied parameters are valid.
7878
NOT IMPLEMENTED YET-- raises NotImplementedError
79+
7980
:param params: a dictionary of parameters
8081
8182
"""
@@ -84,14 +85,15 @@ def validate(self, params):
8485
def build(self, build_parameters=None, build_options=None):
8586
"""
8687
Executes the script, using the optional parameters to override those in the model
88+
8789
: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
8991
: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
9193
: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
9395
: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
9597
"""
9698
if not build_parameters:
9799
build_parameters = {}
@@ -326,7 +328,8 @@ def __init__(self):
326328

327329
def show_object(self, shape, options={}, **kwargs):
328330
"""
329-
return an object to the executing environment, with options
331+
Return an object to the executing environment, with options.
332+
330333
:param shape: a cadquery object
331334
:param options: a dictionary of options that will be made available to the executing environment
332335
"""

0 commit comments

Comments
 (0)