Address reviewer feedback and fix additional issues

Author: dapomeroy

lib/ramble/docs/conf.py

@@ -196,13 +196,28 @@ def setup(sphinx):
     # Python classes that intersphinx is unable to resolve
     ("py:class", "argparse.HelpFormatter"),
     ("py:class", "contextlib.contextmanager"),
+    ("py:class", "func"),
     ("py:class", "module"),
     ("py:class", "_io.BufferedReader"),
+    ("py:class", "ramble.repository._PrependFileLoader"),
     ("py:class", "unittest.case.TestCase"),
     ("py:class", "_frozen_importlib_external.SourceFileLoader"),
     ("py:class", "clingo.Control"),
     ("py:class", "TextIO"),
-    ("py:class", "func"),
+    ("py:class", "llnl.util.argparsewriter.ArgparseCompletionWriter"),
+    ("py:class", "llnl.util.argparsewriter.ArgparseRstWriter"),
+    ("py:class", "llnl.util.argparsewriter.ArgparseWriter"),
+    ("py:class", "llnl.util.lock.Lock"),
+    ("py:class", "pandas.core.frame.DataFrame"),
+    ("py:class", "spack.environment.Environment"),
+    ("py:class", "spack.error.SpackError"),
+    ("py:class", "spack.error.SpecError"),
+    ("py:class", "spack.parse.Lexer"),
+    ("py:class", "spack.parse.Parser"),
+    ("py:class", "spack.package.Package"),
+    ("py:class", "spack.util.environment.EnvironmentModifications"),
+    ("py:class", "spack.util.executable.Executable"),
+    ("py:class", "spack.util.pattern.Composite"),
 ]
 
 # The reST default role (used for this markup: `text`) to use for all documents.

lib/ramble/docs/package_managers.rst

@@ -7,7 +7,7 @@
    except according to those terms.
 
 
-.. _package_manager_control:
+.. _package-manager-control:
 
 ================
 Package Managers

lib/ramble/docs/results.rst

@@ -6,7 +6,7 @@
    option. This file may not be copied, modified, or distributed
    except according to those terms.
 
-.. _workspace:
+.. _results:
 
 ==============
 Ramble Results

lib/ramble/docs/success_criteria.rst

@@ -116,7 +116,7 @@ The above example shows the full interface for defining success criteria with
 * ``fom_context``: (Optional) The context ``fom_name`` should exist in. Defaults to ``null``.
 
 Both ``fom_name`` and ``fom_context`` support
-`python style globbing<https://docs.python.org/3/library/fnmatch.html>`_.
+`python style globbing <https://docs.python.org/3/library/fnmatch.html>`_.
 
 When using the globbing functionality, all contexts that match the
 ``fom_context`` argument are searched. Within each context, all FOMs that match

lib/ramble/docs/tutorials/7_using_zips_and_matrices.rst

@@ -165,7 +165,7 @@ Your final configuration file should look something like:
 .. include:: shared/wrf_execute.rst
 
 **NOTE** Some of these experiments can take a while to execute. Experiments can
-be filtered using the :ref:`--where <filter-experiments>`` option to execute the
+be filtered using the :ref:`--where <filter-experiments>` option to execute the
 higher scale experiments if desired. To do this, try:
 
 .. code-block:: console

lib/ramble/docs/workspace.rst

@@ -421,7 +421,7 @@ the installation and generate software environments for each experiment.
 
 As an example, if the applications and workspace configuration file provide a
 configuration for Spack, Ramble will generate
-`Spack environments<https://spack.readthedocs.io/en/latest/environments.html>`_.
+`Spack environments <https://spack.readthedocs.io/en/latest/environments.html>`_.
 
 By default, Ramble uses the following format for creating a spack environment file:
 

lib/ramble/docs/workspace_config.rst

@@ -1265,7 +1265,7 @@ In the above example, the chained experiment would have a namespace of:
 ``hostname.serial.test_exp2.chain.0.hostname.serial.test_exp1``
 
 The ``name`` attribute can use `globbing
-syntax<https://docs.python.org/3/library/fnmatch.html#module-fnmatch>`_ to chain
+syntax <https://docs.python.org/3/library/fnmatch.html#module-fnmatch>`_ to chain
 multiple experiments at once.
 
 The ``order`` keyword is optional. Valid options include:

lib/ramble/ramble/config.py

@@ -756,8 +756,8 @@ def override(path_or_scope, value=None):
     """Simple way to override config settings within a context.
 
     Arguments:
-        path_or_scope (ConfigScope or str): scope or single option to override
-        value (object or None): value for the single option
+        path_or_scope (ConfigScope | str): scope or single option to override
+        value (object | None): value for the single option
 
     Temporarily push a scope on the current configuration, then remove it
     after the context completes. If a single option is provided, create
@@ -963,8 +963,8 @@ def validate(data, schema, filename=None):
     """Validate data read in from a Ramble YAML file.
 
     Arguments:
-        data (dict or list): data read from a Ramble YAML file
-        schema (dict or list): jsonschema to validate data
+        data (dict | list): data read from a Ramble YAML file
+        schema (dict | list): jsonschema to validate data
 
     This leverages the line information (start_mark, end_mark) stored
     on Ramble YAML structures.

lib/ramble/ramble/context.py

@@ -99,20 +99,22 @@ def create_context_from_dict(context_name, in_dict):
 
     Dictionaries should follow the below format:
 
-    in_dict = {
-        'env_vars': [],
-        'variables': {},
-        'variants': {},
-        'internals': {},
-        'template': '',
-        'chained_experiments': [],
-        'modifiers': [],
-        'context_name': '',
-        'exclude': {},
-        'zips': {},
-        'matrices': {} or [],
-        'tags': [],
-        'n_repeats': ''
+    .. code-block:: python
+
+        in_dict = {
+            'env_vars': [],
+            'variables': {},
+            'variants': {},
+            'internals': {},
+            'template': '',
+            'chained_experiments': [],
+            'modifiers': [],
+            'context_name': '',
+            'exclude': {},
+            'zips': {},
+            'matrices': {} or [],
+            'tags': [],
+            'n_repeats': ''
         }
 
     Args:

lib/ramble/ramble/expander.py

@@ -135,8 +135,7 @@ def relative_indices(self, relative_to):
         """Compute node indices relative to another node
 
         Args:
-            relative_to (ExpansionNode): node to shift current node's indices
-                relative to
+            relative_to (ExpansionNode): node to shift current node's indices relative to
 
         Returns:
             (tuple) indices of shifted match set
@@ -147,8 +146,7 @@ def add_children(self, children):
         """Add children to this node
 
         Args:
-            children (ExpansionNode, or list): nodes to adds as children of
-                self
+            children (ExpansionNode | list): nodes to adds as children of self
         """
         if isinstance(children, list):
             self.children.extend(children)