Skip to content

Commit

Permalink
Refs #11054 Correct comments in diagram directive
Browse files Browse the repository at this point in the history
  • Loading branch information
Harry Jeffery committed Feb 11, 2015
1 parent a391c54 commit 0b033f9
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions Code/Mantid/docs/sphinxext/mantiddoc/directives/diagram.py
Expand Up @@ -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
Expand Down Expand Up @@ -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):
Expand Down

0 comments on commit 0b033f9

Please sign in to comment.