Draft: WorkingPlane, Pythonic style, improved the docstring; these methods only work when 'FreeCAD.GuiUp' is True; it should print a message to the console indicating that.

This commit is contained in:
vocx-fc
2019-08-08 00:59:43 -05:00
committed by Yorik van Havre
parent 15b186bbfe
commit a569bed31b

View File

@@ -585,8 +585,8 @@ class plane:
It extracts the shape of the object or subobject
and then calls `alignToFace(shape, offset)`.
This method only works when the `FreeCADGui.Selection`
class is available, that is, when the graphical interface is loaded.
This method only works when `FreeCAD.GuiUp` is `True`,
that is, when the graphical interface is loaded.
Parameter
---------
@@ -613,6 +613,9 @@ class plane:
The method could work for curves (`'Edge'` or `'Wire'`) but
`alignToCurve()` isn't fully implemented.
When the interface is not loaded it should fail and print
a message, `FreeCAD.Console.PrintError()`.
See also
--------
alignToFace, alignToCurve
@@ -660,8 +663,8 @@ class plane:
To do
-----
It should fail loudly, with a message at least
`FreeCAD.Console.PrintError()`.
When the interface is not loaded it should fail and print
a message, `FreeCAD.Console.PrintError()`.
"""
if self.weak:
if direction and point: