Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Draft: docstrings for the submodules
- Loading branch information
1 parent
cbefa8e
commit d1c0f2f
Showing
6 changed files
with
41 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
"""Commands that require the graphical user interface to work. | ||
These GUI commands are called by buttons, menus, contextual menus, | ||
toolbars, or other ways that require graphical widgets. | ||
They are normally loaded in the workbench's `InitGui.py`. | ||
""" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
"""Functions and classes that define custom scripted objects. | ||
These classes define a custom object which is based on one of the core | ||
objects defined in C++. The custom object inherits some basic properties, | ||
and new properties are added. | ||
Most Draft objects are based on Part::Part2DObject. | ||
""" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
"""Classes that define the task panels of GUI commands. | ||
These classes load `.ui` files that will be used in the task panel | ||
of the graphical commands. | ||
The classes define the behavior and callbacks of the different widgets | ||
included in the `.ui` file. | ||
""" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,7 @@ | ||
# | ||
"""Classes and functions used to test the workbench. | ||
These classes are called by the unit test launcher | ||
that is defined in `Init.py` and `InitGui.py`. | ||
The unit tests are based on the standard `unittest` module. | ||
""" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
"""Utility functions that do not require the graphical user interface. | ||
These functions are used throughout the Draft Workbench. | ||
They can be called from any module, whether it uses the graphical | ||
user interface or not. | ||
""" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
"""Classes that define the viewproviders of custom scripted objects. | ||
These classes define viewproviders for the custom objects | ||
defined in `draftobjects`. | ||
The viewproviders can be used only when the graphical interface | ||
is available; in console mode the viewproviders are not available. | ||
""" |