[yt-svn] commit/yt: MatthewTurk: Merged in ngoldbaum/yt (pull request #2392)

commits-noreply at bitbucket.org commits-noreply at bitbucket.org
Wed Oct 26 08:01:06 PDT 2016


1 new commit in yt:

https://bitbucket.org/yt_analysis/yt/commits/9030614870c4/
Changeset:   9030614870c4
Branch:      yt
User:        MatthewTurk
Date:        2016-10-26 15:00:39+00:00
Summary:     Merged in ngoldbaum/yt (pull request #2392)

Updating recommendations about yielding asserts
Affected #:  1 file

diff -r 095f19df2d00f4bda6c11ba3bd47a517a0dddca2 -r 9030614870c430b62d09a43cf11277551ea493c0 doc/source/developing/testing.rst
--- a/doc/source/developing/testing.rst
+++ b/doc/source/developing/testing.rst
@@ -32,10 +32,10 @@
 
 Unit tests are tests that operate on some small set of machinery, and verify
 that the machinery works.  yt uses the `Nose
-<http://nose.readthedocs.org/en/latest/>`_ framework for running unit tests.
-In practice, what this means is that we write scripts that ``yield``
-assertions, and Nose identifies those scripts, runs them, and verifies that the
-assertions are true.
+<http://nose.readthedocs.org/en/latest/>`_ framework for running unit tests.  In
+practice, what this means is that we write scripts that assert statements, and
+Nose identifies those scripts, runs them, and verifies that the assertions are
+true and the code runs without crashing.
 
 How to Run the Unit Tests
 ^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -104,8 +104,9 @@
    functionality and should also verify that the results are correct using
    assert statements or functions.  
 #. Tests can ``yield`` a tuple of the form ``function``, ``argument_one``,
-   ``argument_two``, etc.  For example ``yield assert_equal, 1.0, 1.0`` would be
-   captured by nose as a test that asserts that 1.0 is equal to 1.0.
+   ``argument_two``, etc.  For example ``yield my_test, 'banana', 2.0`` would be
+   captured by nose and the ``my_test`` function will be run with the provided
+   arguments.
 #. Use ``fake_random_ds`` to test on datasets, and be sure to test for
    several combinations of ``nproc``, so that domain decomposition can be
    tested as well.

Repository URL: https://bitbucket.org/yt_analysis/yt/

--

This is a commit notification from bitbucket.org. You are receiving
this because you have the service enabled, addressing the recipient of
this email.


More information about the yt-svn mailing list