some documentation fixes

IDSIA · Jun 25, 2015 · 211335f · 211335f
1 parent c21a69c
commit 211335f
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 4 deletions.
diff --git a/docs/configuration.rst b/docs/configuration.rst
@@ -96,7 +96,6 @@ Or equivalently:
 
 .. code-block:: python
 
-    # or equivalently
     ex.add_config(
         foo=42,
         bar='baz'

diff --git a/sacred/experiment.py b/sacred/experiment.py
@@ -100,7 +100,8 @@ def run(self, config_updates=None, named_configs=(), loglevel=None):
         :param loglevel: Changes to the log-level for this run.
         :type loglevel: int | str
 
-        :return: The result of the main function.
+        :returns: the Run object corresponding to the finished run
+        :rtype: sacred.run.Run
         """
         assert self.default_command, "No main function found"
         return self.run_command(self.default_command,
@@ -116,7 +117,8 @@ def run_commandline(self, argv=None):
 
         :param argv: split command-line like ``sys.argv``.
         :type argv: list[str]
-        :return: The result of the command that was run.
+        :returns: the Run object corresponding to the finished run
+        :rtype: sacred.run.Run
         """
         if argv is None:
             argv = sys.argv

diff --git a/sacred/ingredient.py b/sacred/ingredient.py
@@ -242,7 +242,8 @@ def run_command(self, command_name, config_updates=None,
         :param log_level: the log-level to use for this run either as integers
                          or strings (10 DEBUG - 50 CRITICAL)
         :type log_level: int | str
-        :returns: whatever the command returned
+        :returns: the Run object corresponding to the finished run
+        :rtype: sacred.run.Run
         """
         run = self._create_run_for_command(
             command_name, config_updates, named_configs_to_use, log_level)