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

commits-noreply at bitbucket.org commits-noreply at bitbucket.org
Wed May 25 11:11:17 PDT 2016


1 new commit in yt:

https://bitbucket.org/yt_analysis/yt/commits/f18feeb0dd61/
Changeset:   f18feeb0dd61
Branch:      yt
User:        xarthisius
Date:        2016-05-25 18:11:04+00:00
Summary:     Merged in ngoldbaum/yt (pull request #2189)

[doc] updates for docs on writing unit tests to reflect current practices
Affected #:  1 file

diff -r ccc15506d8e364f86cde99f04e5db48b4272e61d -r f18feeb0dd6163476732e6a4d85447b8c117a0d1 doc/source/developing/testing.rst
--- a/doc/source/developing/testing.rst
+++ b/doc/source/developing/testing.rst
@@ -95,17 +95,17 @@
 To create new unit tests:
 
 #. Create a new ``tests/`` directory next to the file containing the
-   functionality you want to test.  Be sure to add this new directory as a
-   subpackage in the setup.py script located in the directory you're adding a
-   new ``tests/`` folder to.  This ensures that the tests will be deployed in
-   yt source and binary distributions.
+   functionality you want to test and add an empty ``__init__.py`` file to
+   it.
 #. Inside that directory, create a new python file prefixed with ``test_`` and
    including the name of the functionality.
 #. Inside that file, create one or more routines prefixed with ``test_`` that
-   accept no arguments.  These should ``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.
+   accept no arguments. The test function should do some work that tests some
+   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.
 #. 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