Show More
@@ -127,10 +127,10 b' If an IPython doctest decorator is found, it will take these steps when your doc' | |||||
127 | 1. Run the *input* lines in your IPython directive block against the current Python kernel (remember that the session |
|
127 | 1. Run the *input* lines in your IPython directive block against the current Python kernel (remember that the session | |
128 | persists across IPython directive blocks); |
|
128 | persists across IPython directive blocks); | |
129 |
|
129 | |||
130 |
2. Compare the *output* of this with the output text that you've put in the IPython directive block |
|
130 | 2. Compare the *output* of this with the output text that you've put in the IPython directive block (what comes | |
131 | after `Out[NN]`); |
|
131 | after `Out[NN]`); | |
132 |
|
132 | |||
133 |
3. If there is a difference, the directive will raise an error and your documentation build will f |
|
133 | 3. If there is a difference, the directive will raise an error and your documentation build will fail. | |
134 |
|
134 | |||
135 | You can do doctesting on multi-line output as well. Just be careful |
|
135 | You can do doctesting on multi-line output as well. Just be careful | |
136 | when using non-deterministic inputs like random numbers in the ipython |
|
136 | when using non-deterministic inputs like random numbers in the ipython |
General Comments 0
You need to be logged in to leave comments.
Login now