Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Nitin Madnani <nmadnani@ets.org>
  • Loading branch information
aloukina and desilinguist committed Sep 29, 2020
1 parent 1d4cf8b commit ee4b0e4
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion doc/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -179,7 +179,7 @@ Here are some advanced tips and tricks when working with RSMTool tests.

4. The ``--pdb-errors`` and ``--pdb-failures`` options for ``nosetests`` are your friends. If you encounter test errors or test failures where the cause may not be immediately clear, re-run the ``nosetests`` command with the appropriate option. Doing so will drop you into an interactive PDB session as soon as a error (or failure) is encountered and then you inspect the variables at that point (or use "u" and "d" to go up and down the call stack). This may be particularly useful for tests in ``tests/test_cli.py`` that use ``subprocess.run()``. If these tests are erroring out, use ``--pdb-errors`` and inspect the "stderr" variable in the resulting PDB session to see what the error is.

5. In RSMTool 8.0.1 and later by default the tests will pass even if the reports contain warnings. To catch any warnings that may appear in the reports run the tests in strict mode (``STRICT=1 nosetests --nologcapture tests``).
5. In RSMTool 8.0.1 and later, the tests will pass even if any of the reports contain warnings. To catch any warnings that may appear in the reports, run the tests in strict mode (``STRICT=1 nosetests --nologcapture tests``).

.. rubric:: Footnotes

Expand Down
6 changes: 3 additions & 3 deletions rsmtool/configuration_parser.py
Original file line number Diff line number Diff line change
Expand Up @@ -563,7 +563,7 @@ def check_flag_column(self,

def get_trim_min_max_tolerance(self):
"""
Get trim min, trim max and tolerance.
Get trim min, trim max, and tolerance.
Get the specified trim min and max,
and trim_tolerance if any,
Expand Down Expand Up @@ -689,7 +689,7 @@ def get_names_and_paths(self, keys, names):


class ConfigurationParser:
"""A `ConfigurationParser` class to create a `Configuration` object."""
"""A ``ConfigurationParser`` class to create a ``Configuration`` object."""

def __init__(self, pathlike):
"""
Expand Down Expand Up @@ -795,7 +795,7 @@ def _parse_json_file(self, filepath):

def parse(self, context='rsmtool'):
"""
Parse the configuration file.
Parse configuration file.
Parse the configuration file for which this parser was
instantiated.
Expand Down

0 comments on commit ee4b0e4

Please sign in to comment.