From 3e36801ea328385bb4dfaad5969ebcdf1b41353b Mon Sep 17 00:00:00 2001 From: Paul Romano Date: Fri, 27 Mar 2020 07:49:53 -0500 Subject: [PATCH] Update docstring for Model.run --- openmc/model/model.py | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/openmc/model/model.py b/openmc/model/model.py index 896e061194..4115e4f917 100644 --- a/openmc/model/model.py +++ b/openmc/model/model.py @@ -198,18 +198,18 @@ class Model: self.plots.export_to_xml(d) def run(self, **kwargs): - """Creates the XML files, runs OpenMC, and returns k-effective. - The last statepoint Path is available in model.statepoint + """Creates the XML files, runs OpenMC, and returns the path to the last + statepoint file generated. Parameters ---------- **kwargs - All keyword arguments are passed to :func:`openmc.run` + Keyword arguments passed to :func:`openmc.run` Returns ------- Path - the name of the last statepoint written by this run + Path to the last statepoint written by this run (None if no statepoint was written) """