Updated docs

W. Trevor King: I dropped everything from the original 87c5ce2 except
for the 5-Testing/ modification.

Conflicts:
	6-Documentation/Readme.md
	6-Documentation/Readme.rst

diff --git a/5-Testing/Readme.md b/5-Testing/Readme.md
index 07a6107b4e738c56073dcad852fb33c9631eecb9..c59d4e3eb4df4c63d241ada2714972137544880e 100644 (file)
--- a/5-Testing/Readme.md
+++ b/5-Testing/Readme.md
@@ -35,6 +35,8 @@ following questions:
 -   Does it respond properly for a full range of input parameters?
 -   What about edge or corner cases?
 -   What's the limit on that input parameter?
 -   Does it respond properly for a full range of input parameters?
 -   What about edge or corner cases?
 -   What's the limit on that input parameter?

+-   How will it affect your
+    [publications](http://www.nature.com/news/2010/101013/full/467775a.html)?

 
 ## Verification
 
 
 ## Verification
 


@@ -523,15 +525,16 @@ define a line segment. Additionally there exists experimental data which
 can be anywhere in the domain. Find the data point which is closest to
 the line segment.
 
 can be anywhere in the domain. Find the data point which is closest to
 the line segment.
 

-![image](https://github.com/thehackerwithin/UofCSCBC2012/raw/scopz/5-Testing/evo_sol1.png)

 In the `close_line.py` file there are four different implementations
 which all solve this problem. [You can read more about them
 here.](http://inscight.org/2012/03/31/evolution_of_a_solution/) However,
 there are no tests! Please write from scratch a `test_close_line.py`
 In the `close_line.py` file there are four different implementations
 which all solve this problem. [You can read more about them
 here.](http://inscight.org/2012/03/31/evolution_of_a_solution/) However,
 there are no tests! Please write from scratch a `test_close_line.py`

-file which tests the closest\_data\_to\_line() functions. *Hint:* you
-can use one implementation to test another. Below is some sample data to
-help you get started.
+file which tests the closest\_data\_to\_line() functions.
+
+*Hint:* you can use one implementation function to test another. Below
+is some sample data to help you get started.

 
 

+![image](https://github.com/thehackerwithin/UofCSCBC2012/raw/scopz/5-Testing/evo_sol1.png)

 ```python
 import numpy as np
 
 ```python
 import numpy as np
 

diff --git a/5-Testing/Readme.rst b/5-Testing/Readme.rst
index 97b98ea7a074cecc655ab85a24349ed56b20b81c..0eda24f71ca9778d7d76404f13e11123d28670d3 100644 (file)
--- a/5-Testing/Readme.rst
+++ b/5-Testing/Readme.rst
@@ -34,6 +34,9 @@ enough to answer in the affirmative to at least a few of the following questions
 * Does it respond properly for a full range of input parameters?
 * What about edge or corner cases?
 * What's the limit on that input parameter?
 * Does it respond properly for a full range of input parameters?
 * What about edge or corner cases?
 * What's the limit on that input parameter?

+* How will it affect your `publications`_?
+
+.. _publications: http://www.nature.com/news/2010/101013/full/467775a.html

 
 Verification
 ************
 
 Verification
 ************


@@ -501,17 +504,15 @@ Exercise
 Additionally there exists experimental data which can be anywhere in the domain. 
 Find the data point which is closest to the line segment. 
 
 Additionally there exists experimental data which can be anywhere in the domain. 
 Find the data point which is closest to the line segment. 
 

-
-.. image:: https://github.com/thehackerwithin/UofCSCBC2012/raw/scopz/5-Testing/evo_sol1.png
-
-

 In the ``close_line.py`` file there are four different implementations which all
 solve this problem.  `You can read more about them here.`_  However, there are no tests!
 Please write from scratch a ``test_close_line.py`` file which tests the closest_data_to_line() 
 In the ``close_line.py`` file there are four different implementations which all
 solve this problem.  `You can read more about them here.`_  However, there are no tests!
 Please write from scratch a ``test_close_line.py`` file which tests the closest_data_to_line() 

-functions.  *Hint:* you can use one implementation to test another.  Below is some sample data
+functions.  
+
+*Hint:* you can use one implementation function to test another.  Below is some sample data

 to help you get started.
 
 to help you get started.
 

-.. _You can read more about them here.: http://inscight.org/2012/03/31/evolution_of_a_solution/
+.. image:: https://github.com/thehackerwithin/UofCSCBC2012/raw/scopz/5-Testing/evo_sol1.png

 
 .. code-block:: python
 
 
 .. code-block:: python
 


@@ -520,3 +521,7 @@ to help you get started.
     p1 = np.array([0.0, 0.0])
     p2 = np.array([1.0, 1.0])
     data = np.array([[0.3, 0.6], [0.25, 0.5], [1.0, 0.75]])
     p1 = np.array([0.0, 0.0])
     p2 = np.array([1.0, 1.0])
     data = np.array([[0.3, 0.6], [0.25, 0.5], [1.0, 0.75]])

+
+.. _You can read more about them here.: http://inscight.org/2012/03/31/evolution_of_a_solution/
+
+