Arnike/watcher
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge "[Doc] Fix example code of goal plugin"

Browse Source
This commit is contained in:
Jenkins
2016-12-07 12:26:50 +00:00
committed by Gerrit Code Review
parent 6638f921a3 d0e46d81fc
commit c08666b2fa
1 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
doc/source/dev/plugin/goal-plugin.rst
View File

@@ -60,8 +60,8 @@ Here is an example showing how you can define a new ``NewGoal`` goal plugin:
# import path: thirdparty.new # import path: thirdparty.new
from watcher._i18n import _ from watcher._i18n import _
from watcher.decision_engine.goal import base
from watcher.decision_engine.goal.efficacy import specs from watcher.decision_engine.goal.efficacy import specs
from watcher.decision_engine.strategy.strategies import base
class NewGoal(base.Goal): class NewGoal(base.Goal):
@@ -79,11 +79,11 @@ Here is an example showing how you can define a new ``NewGoal`` goal plugin:
@classmethod @classmethod
def get_efficacy_specification(cls): def get_efficacy_specification(cls):
return specs.UnclassifiedStrategySpecification() return specs.Unclassified()
As you may have noticed, the :py:meth:`~.Goal.get_efficacy_specification` As you may have noticed, the :py:meth:`~.Goal.get_efficacy_specification`
method returns an :py:meth:`~.UnclassifiedStrategySpecification` instance which method returns an :py:meth:`~.Unclassified` instance which
is provided by Watcher. This efficacy specification is useful during the is provided by Watcher. This efficacy specification is useful during the
development process of your goal as it corresponds to an empty specification. development process of your goal as it corresponds to an empty specification.
If you want to learn more about what efficacy specifications are used for or to If you want to learn more about what efficacy specifications are used for or to