Skip to content

Commit 778cb52

Browse files
More docs corrections
1 parent b841be5 commit 778cb52

1 file changed

Lines changed: 13 additions & 13 deletions

File tree

doc/quickstart.rst

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ with place-holders for the dimensions. Add this code to your script file:
6868
# Render the solid
6969
show(result)
7070
71-
Press the green Render button in the toolbar to run the script. You should see our base object.
71+
Run the script. You should see our base object.
7272

7373
.. image:: _static/quickstart/002.png
7474

@@ -105,16 +105,16 @@ This modification will do the trick:
105105
# Render the solid
106106
show(result)
107107
108-
Rebuild your model by clicking the Render button. Your block should look like this:
108+
Rebuild your model by rerunning the script. Your block should look like this:
109109

110110
.. image:: _static/quickstart/003.png
111111

112112

113113
The code is pretty compact, let's step through it.
114114

115-
**Line 4** adds a new parameter, diameter, for the diameter of the hole
115+
**Line 7** adds a new parameter, diameter, for the diameter of the hole
116116

117-
**Lines 10-12**, we're adding the hole.
117+
**Lines 13-15**, we're adding the hole.
118118
:py:meth:`cadquery.Workplane.faces` selects the top-most face in the Z direction, and then
119119
:py:meth:`cadquery.Workplane.workplane` begins a new workplane located on this face. The center of this workplane
120120
is located at the center of mass of the shape, which in this case is the center of the plate.
@@ -125,7 +125,7 @@ Finally, :py:meth:`cadquery.Workplane.hole` drills a hole through the part, 22mm
125125
Don't worry about the CadQuery syntax now.. you can learn all about it in the :ref:`apireference` later.
126126

127127
More Holes
128-
============
128+
==========
129129

130130
Ok, that hole was not too hard, but what about the counter-bored holes in the corners?
131131

@@ -172,19 +172,19 @@ Good news!-- we can get the job done with just a few lines of code. Here's the c
172172
show(result)
173173
174174
175-
After clicking the Render button to re-execute the model, you should see something like this:
175+
After running the script again, you should see something like this:
176176

177177
.. image:: _static/quickstart/004.png
178178

179179

180180
There is quite a bit going on here, so let's break it down a bit.
181181

182-
**Line 5** creates a new padding parameter that decides how far the holes are from the edges of the plate.
182+
**Line 8** creates a new padding parameter that decides how far the holes are from the edges of the plate.
183183

184-
**Lines 14-15** selects the top-most face of the block, and creates a workplane on the top of that face, which we'll use to
184+
**Lines 17-18** selects the top-most face of the block, and creates a workplane on the top of that face, which we'll use to
185185
define the centers of the holes in the corners.
186186

187-
**Line 16** draws a rectangle 12mm smaller than the overall length and width of the block, which we will use to
187+
**Line 19** draws a rectangle 12mm smaller than the overall length and width of the block, which we will use to
188188
locate the corner holes. We'll use the vertices ( corners ) of this rectangle to locate the holes. The rectangle's
189189
center is at the center of the workplane, which in this case coincides with the center of the bearing hole.
190190

@@ -196,10 +196,10 @@ There are a couple of things to note about this line:
196196
2. Unless you specify otherwise, a rectangle is drawn with its center on the current workplane center-- in
197197
this case, the center of the top face of the block. So this rectangle will be centered on the face.
198198

199-
**Line 17** selects the vertices of the rectangle, which we will use for the centers of the holes.
199+
**Line 20** selects the vertices of the rectangle, which we will use for the centers of the holes.
200200
The :py:meth:`cadquery.Workplane.vertices` function selects the corners of the rectangle.
201201

202-
**Line 18** uses the cboreHole function to draw the holes.
202+
**Line 21** uses the cboreHole function to draw the holes.
203203
The :py:meth:`cadquery.Workplane.cboreHole` function is a handy CadQuery function that makes a counterbored hole.
204204
Like most other CadQuery functions, it operates on the values on the stack. In this case, since we
205205
selected the four vertices before calling the function, the function operates on each of the four points--
@@ -246,10 +246,10 @@ We can do that using the preset dictionaries in the parameter definition:
246246
# Render the solid
247247
show(result)
248248
249-
**Line 19** To grab the right edges, the :py:meth:`cadquery.Workplane.edges` selects all of the
249+
**Line 22** To grab the right edges, the :py:meth:`cadquery.Workplane.edges` selects all of the
250250
edges that are parallel to the Z axis ("\|Z").
251251

252-
**Line 20** fillets the edges using the :py:meth:`cadquery.Workplane.fillet` method.
252+
**Line 23** fillets the edges using the :py:meth:`cadquery.Workplane.fillet` method.
253253

254254
The finished product looks like this:
255255

0 commit comments

Comments
 (0)