From 0b033f9b01a3fda396ae816e392b3b6954df3433 Mon Sep 17 00:00:00 2001 From: Harry Jeffery Date: Wed, 11 Feb 2015 15:11:47 +0000 Subject: [PATCH] Refs #11054 Correct comments in diagram directive --- .../Mantid/docs/sphinxext/mantiddoc/directives/diagram.py | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/Code/Mantid/docs/sphinxext/mantiddoc/directives/diagram.py b/Code/Mantid/docs/sphinxext/mantiddoc/directives/diagram.py index b1e981f8353c..3daf8b8fa06e 100644 --- a/Code/Mantid/docs/sphinxext/mantiddoc/directives/diagram.py +++ b/Code/Mantid/docs/sphinxext/mantiddoc/directives/diagram.py @@ -31,9 +31,9 @@ class DiagramDirective(BaseDirective): """ Adds a diagram from a dot source file - It requires a DIAGRAMS_DIR environment variable to be set to the - directory where a diagram should be generated. If it is not set then - a RuntimeError occurs + It requires DIAGRAMS_DIR and DOT_EXECUTABLE environment variables to be set to the + directory where a diagram should be generated and where the dot program may be found, + respectively. If they are not set then a RuntimeError occurs """ required_arguments, optional_arguments = 1, 0 @@ -61,7 +61,7 @@ def execute(self): try: dot_executable = os.environ["DOT_EXECUTABLE"] except: - raise RuntimeError("The '.. diagram::' directive requires a DIAGRAMS_DIR environment variable to be set.") + raise RuntimeError("The '.. diagram::' directive requires a DOT_EXECUTABLE environment variable to be set.") #Make sure we have an output directory if not os.path.exists(out_dir):