DOC : Improve api docs for pyface.undo and pyface.undo.action (#847)

modified: pyface/undo/action/api.py modified: pyface/undo/api.py
enthought · Dec 16, 2020 · 98e191c · 98e191c
1 parent 3a05cca
commit 98e191c
Show file tree

Hide file tree

Showing 2 changed files with 29 additions and 0 deletions.
diff --git a/pyface/undo/action/api.py b/pyface/undo/action/api.py
@@ -22,6 +22,19 @@
 # Description: <Enthought undo package component>
 # ------------------------------------------------------------------------------
 
+"""
+
+API for ``pyface.undo.action``.
+
+CommandAction and useful subclasses
+-----------------------------------
+
+- :class:`~.CommandAction`
+- :class:`~.RedoAction`
+- :class:`~.UndoAction`
+
+"""
+
 from .command_action import CommandAction
 from .redo_action import RedoAction
 from .undo_action import UndoAction
diff --git a/pyface/undo/api.py b/pyface/undo/api.py
@@ -12,6 +12,22 @@
 # Description: <Enthought undo package component>
 # ------------------------------------------------------------------------------
 
+"""
+
+API for ``pyface.undo``.
+
+Interfaces and Implementations
+------------------------------
+
+- :class:`~.ICommand`
+- :class:`~.AbstractCommand`
+- :class:`~.ICommandStack`
+- :class:`~.CommandStack`
+- :class:`~.IUndoManager`
+- :class:`~.UndoManager`
+
+"""
+
 from .abstract_command import AbstractCommand
 from .command_stack import CommandStack
 from .i_command import ICommand