fixed minor documentation errors

This commit is contained in:
Dave Cowden 2014-07-20 09:52:47 -04:00
parent f375f1ff90
commit e1202992f5
4 changed files with 5 additions and 6 deletions

View File

@ -675,7 +675,7 @@ class CQ(object):
def translate(self,vec):
"""
Returns a copy of all of the items on the stack by the specified distance
Returns a copy of all of the items on the stack moved by the specified translation vector.
:param tupleDistance: distance to move, in global coordinates
:type tupleDistance: a 3-tuple of float

View File

@ -278,8 +278,7 @@ class Workplane(CQ):
#line a specified incremental amount from current point
def line(self, xDist, yDist ,forConstruction=False):
"""
Make a line from the current point to the provided point, using
dimensions relative to the current point
Make a line from the current point to the provided point, using dimensions relative to the current point
:param float xDist: x distance from current point
:param float yDist: y distance from current point

View File

@ -106,7 +106,7 @@ for a line. CadQuery shields you from these constructs.
CadQuery Concepts
======================
CadQuery provides functions several key areas. As you would expect, many are devoted to easy creation of
CadQuery provides functions in several key areas. As you would expect, many are devoted to easy creation of
2D and 3D features. But just as many, if not more, are for navigating and selecting objects.
* CQ, the CadQuery object

View File

@ -28,7 +28,7 @@ CadQuery is inspired by ( `jQuery <http://www.jquery.com>`_ ), a popular framewo
revolutionized web development involving javascript.
CadQuery is for 3D CAD what jQuery is for javascript.
If you are familiar with how jQuery, you will probably recognize several jQuery features that CadQuery uses:
If you are familiar with how jQuery works, you will probably recognize several jQuery features that CadQuery uses:
* A fluent api to create clean, easy to read code
@ -43,7 +43,7 @@ Why ParametricParts instead of OpenSCAD?
CadQuery is based on FreeCAD,which is in turn based on the OpenCascade modelling kernel. CadQuery/FreeCAD scripts
share many features with OpenSCAD, another open source, script based, parametric model generator.
The primary advantage of OpenSCAD is the large number of already existing model libaries that exist already. So why not simply use OpenSCAD?
The primary advantage of OpenSCAD is the large number of model libaries that exist already. So why not simply use OpenSCAD?
CadQuery scripts run from ParametricParts.com have several key advantages over OpenSCAD ( including the various web-based SCAD solutions):