Skip to content

Commit

Permalink
Draft: docstrings for the submodules
Browse files Browse the repository at this point in the history
  • Loading branch information
vocx-fc authored and yorikvanhavre committed Apr 7, 2020
1 parent cbefa8e commit d1c0f2f
Show file tree
Hide file tree
Showing 6 changed files with 41 additions and 1 deletion.
6 changes: 6 additions & 0 deletions src/Mod/Draft/draftguitools/__init__.py
@@ -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`.
"""
8 changes: 8 additions & 0 deletions src/Mod/Draft/draftobjects/__init__.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.
"""
7 changes: 7 additions & 0 deletions src/Mod/Draft/drafttaskpanels/__init__.py
@@ -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.
"""
8 changes: 7 additions & 1 deletion src/Mod/Draft/drafttests/__init__.py
@@ -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.
"""
6 changes: 6 additions & 0 deletions src/Mod/Draft/draftutils/__init__.py
@@ -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.
"""
7 changes: 7 additions & 0 deletions src/Mod/Draft/draftviewproviders/__init__.py
@@ -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.
"""

0 comments on commit d1c0f2f

Please sign in to comment.