From 1e5ef8a02f7f58549034865851a0c4e0304938fb Mon Sep 17 00:00:00 2001
From: Stefano Borini <sborini@enthought.com>
Date: Tue, 22 Aug 2017 11:48:16 +0100
Subject: [PATCH] Documentation fixes
---
force_bdss/ui_hooks/base_ui_hooks_factory.py | 14 +++++++-------
force_bdss/ui_hooks/base_ui_hooks_manager.py | 5 ++---
2 files changed, 9 insertions(+), 10 deletions(-)
diff --git a/force_bdss/ui_hooks/base_ui_hooks_factory.py b/force_bdss/ui_hooks/base_ui_hooks_factory.py
index e9b1295..b183489 100644
--- a/force_bdss/ui_hooks/base_ui_hooks_factory.py
+++ b/force_bdss/ui_hooks/base_ui_hooks_factory.py
@@ -8,9 +8,9 @@ from .i_ui_hooks_factory import IUIHooksFactory
@provides(IUIHooksFactory)
class BaseUIHooksFactory(ABCHasStrictTraits):
- """Base class for notification listeners.
- Notification listeners are extensions that receive event notifications
- from the MCO and perform an associated action.
+ """Base class for UIHooksFactory.
+ UI Hooks are extensions that perform actions associated to specific
+ moments of the UI lifetime.
"""
#: identifier of the factory
id = String()
@@ -33,12 +33,12 @@ class BaseUIHooksFactory(ABCHasStrictTraits):
super(BaseUIHooksFactory, self).__init__(*args, **kwargs)
@abc.abstractmethod
- def create_ui_hook_manager(self):
- """Creates an instance of the hook manager
- The hook manager contains a set of methods that are applicable in
+ def create_ui_hooks_manager(self):
+ """Creates an instance of the hook manager.
+ The hooks manager contains a set of methods that are applicable in
various moments of the UI application lifetime.
Returns
-------
- BaseUIHookManager
+ BaseUIHooksManager
"""
diff --git a/force_bdss/ui_hooks/base_ui_hooks_manager.py b/force_bdss/ui_hooks/base_ui_hooks_manager.py
index ff71acc..41eabae 100644
--- a/force_bdss/ui_hooks/base_ui_hooks_manager.py
+++ b/force_bdss/ui_hooks/base_ui_hooks_manager.py
@@ -1,10 +1,9 @@
-import abc
-from traits.api import ABCHasStrictTraits, Instance
+from traits.api import HasStrictTraits, Instance
from .i_ui_hooks_factory import IUIHooksFactory
-class BaseUIHooksManager(ABCHasStrictTraits):
+class BaseUIHooksManager(HasStrictTraits):
#: A reference to the factory
factory = Instance(IUIHooksFactory)
--
GitLab