Skip to content

Commit 8431073

Browse files
authored
Update quickstart documentation inconsistencies (#1871)
The referenced line numbers following the code-block in the More Holes section weren't pointing at the highlighted lines which I believe was not the intent, I updated it to what seemed correct. I also re-arranged some sections to follow the top-down flow the rest of the document seems to be following. I'm new this library and the CAD domain entirely so these stood out to my beginner's eyes. Really liking this project so far!
1 parent b94a067 commit 8431073

File tree

1 file changed

+9
-10
lines changed

1 file changed

+9
-10
lines changed

doc/quickstart.rst

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@ Good news!-- we can get the job done with just a few lines of code. Here's the c
134134

135135
.. code-block:: python
136136
:linenos:
137-
:emphasize-lines: 5,14-17
137+
:emphasize-lines: 5,14-18
138138
139139
height = 60.0
140140
width = 80.0
@@ -168,9 +168,13 @@ There is quite a bit going on here, so let's break it down a bit.
168168

169169
**Line 5** creates a new padding parameter that decides how far the holes are from the edges of the plate.
170170

171-
**Lines 11-12** selects the top-most face of the block, and creates a workplane on the top of that face, which we'll use to
171+
**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
172172
define the centers of the holes in the corners.
173173

174+
**Line 16** draws a rectangle 12mm smaller than the overall length and width of the block, which we will use to
175+
locate the corner holes. We'll use the vertices ( corners ) of this rectangle to locate the holes. The rectangle's
176+
center is at the center of the workplane, which in this case coincides with the center of the bearing hole.
177+
174178
There are a couple of things to note about this line:
175179

176180
1. The :py:meth:`cadquery.Workplane.rect` function draws a rectangle. **forConstruction=True**
@@ -179,11 +183,6 @@ There are a couple of things to note about this line:
179183
2. Unless you specify otherwise, a rectangle is drawn with its center on the current workplane center-- in
180184
this case, the center of the top face of the block. So this rectangle will be centered on the face.
181185

182-
183-
**Line 16** draws a rectangle 12mm smaller than the overall length and width of the block, which we will use to
184-
locate the corner holes. We'll use the vertices ( corners ) of this rectangle to locate the holes. The rectangle's
185-
center is at the center of the workplane, which in this case coincides with the center of the bearing hole.
186-
187186
**Line 17** selects the vertices of the rectangle, which we will use for the centers of the holes.
188187
The :py:meth:`cadquery.Workplane.vertices` function selects the corners of the rectangle.
189188

@@ -231,10 +230,10 @@ We can do that using the preset dictionaries in the parameter definition:
231230
# Render the solid
232231
show_object(result)
233232
234-
**Line 20** fillets the edges using the :py:meth:`cadquery.Workplane.fillet` method.
233+
**Line 19** To grab the right edges, the :py:meth:`cadquery.Workplane.edges` selects all of the
234+
edges that are parallel to the Z axis ("\|Z").
235235

236-
To grab the right edges, the :py:meth:`cadquery.Workplane.edges` selects all of the
237-
edges that are parallel to the Z axis ("\|Z"),
236+
**Line 20** fillets the edges using the :py:meth:`cadquery.Workplane.fillet` method.
238237

239238
The finished product looks like this:
240239

0 commit comments

Comments
 (0)