Draft: docstrings for the submodules
This commit is contained in:
@@ -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`.
|
||||
"""
|
||||
|
||||
@@ -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.
|
||||
"""
|
||||
|
||||
@@ -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.
|
||||
"""
|
||||
|
||||
@@ -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.
|
||||
"""
|
||||
|
||||
@@ -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.
|
||||
"""
|
||||
|
||||
@@ -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.
|
||||
"""
|
||||
|
||||
Reference in New Issue
Block a user