From f555e66d7512651756dce24cc9600512f19188f3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vincent=20Fran=C3=A7oise?= Date: Wed, 2 Dec 2015 16:55:08 +0100 Subject: [PATCH] Fixed doc generation warning The BaseStrategy interface was moved to another location but the documentation wasn't updated accordingly, so here I updated this import path. As an extra, I also updated the description of the Solution which also had an outdated import path. Closes-Bug: #1522034 Change-Id: I8cd43e84db6945391db06ec6dfe82ce02eccc7f4 --- doc/source/dev/plugins.rst | 2 +- watcher/decision_engine/strategy/base.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/source/dev/plugins.rst b/doc/source/dev/plugins.rst index cb9ca0016..a04d7f0ed 100644 --- a/doc/source/dev/plugins.rst +++ b/doc/source/dev/plugins.rst @@ -64,7 +64,7 @@ Abstract Plugin Class Here below is the abstract ``BaseStrategy`` class that every single strategy should implement: -.. automodule:: watcher.decision_engine.api.strategy.strategy +.. automodule:: watcher.decision_engine.strategy.base :noindex: .. autoclass:: BaseStrategy diff --git a/watcher/decision_engine/strategy/base.py b/watcher/decision_engine/strategy/base.py index 7ae69edd7..37e881aeb 100644 --- a/watcher/decision_engine/strategy/base.py +++ b/watcher/decision_engine/strategy/base.py @@ -47,7 +47,7 @@ class BaseStrategy(object): :param model: The name of the strategy to execute (loaded dynamically) :type model: str :return: A computed solution (via a placement algorithm) - :rtype: :class:`watcher.decision_engine.api.strategy.solution.Solution` + :rtype: :class:`watcher.decision_engine.solution.base.Solution` """ @property