Merge pull request #203 from datacamp/doc-update-squash

Squashed commit of the following:

Author: machow

docs/source/Home.md

@@ -41,8 +41,6 @@ To robustly test the equality of objects, and results of evaluations, it has to
 
 The remainder of the wiki goes over every test function that `pythonwhat` features, explaining all arguments and covering different use cases. They will give you an idea of how, why and when to use them.
 
-For more full examples of SCTs for Python exercises on DataCamp, check out the [source files of the introduction to Python course](http://www.github.com/datacamp/courses-intro-to-python). In the chapter files there, you can can see the SCTs that have been written for several exercises.
-
-To test your understanding of writing SCTs for Python exercises on the DataCamp platform, you can take the course [Writing SCTs with pythonwhat](https://www.datacamp.com/courses/writing-scts-with-pythonwhat) course.
+For more full examples of SCTs for Python exercises on DataCamp, check out the [source files of the pythonwhat tutorial course](http://www.github.com/datacamp/courses-pythonwhat-tutorial). In the chapter files there, you can can see the SCTs that have been written for several exercises. Another useful course is [introduction to Python](http://www.github.com/datacamp/courses-intro-to-python).
 
 After reading through this documentation, we hope writing SCTs for Python exercises on DataCamp becomes a painless experience. If this is not the case and you think improvements to `pythonwhat` and this documentation are possible, [please let us know](mailto:content-engineering@datacamp.com)!

docs/source/part_checks.rst

@@ -209,6 +209,52 @@ followed by its iterator.
         .multi(check_body().has_equal_value()) \
         .check_iter().has_equal_value()
 
+has_context
+~~~~~~~~~~~~~
+
+.. autofunction:: pythonwhat.check_has_context.has_context
+
+Tests whether context variables defined by the student match the solution, for a selected block of code.
+A context variable is one that is defined in a looping or block statement.
+For example, ``ii`` in the code below.
+
+.. code::
+
+    [ii + 1 for ii in range(3)]
+
+By default, the test fails if the submission code does not have the same number of context variables.
+This is illustrated below.
+
+**Solution Code**
+
+.. code::
+
+    # ii and ltr are context variables
+    for ii, ltr in enumerate(['a']): pass
+
+**SCT**
+
+.. code::
+
+    Ex().check_for_loop(0).check_body().has_context()
+
+**Passing Submission**
+
+.. code::
+
+    # still 2 variables, just different names
+    for jj, Ltr in enumerate(['a']): pass
+
+**Failing Submission**
+
+.. code::
+
+   # only 1 variable
+   for ii in enumerate(['a']): pass
+
+.. note::
+   
+   that if you use ``has_context(exact_names = True)``, then the submission must use the same names for the context variables,    which would cause the passing submission above to fail.
 
 set_context
 ~~~~~~~~~~~~~

docs/source/quickstart_guide.md

@@ -47,13 +47,13 @@ The SCT uses three `pythonwhat` chains to test the correctness of the student's
 In all the test statements above, feedback messages will be automatically generated when something goes wrong. However, it is possible to manually set these feedback messages. For example, in the code below,
 
 ```python
-Ex().check_object(undefined_msg="`x` is undefined!") \
+Ex().check_object(missing_msg="`x` is undefined!") \
     .has_equal_value(incorrect_msg="wrong value for `x`")
 ```
 
 the automatic messages for when `x` is undefined or incorrect are replaced with manual feedback. Now, if students submit `x = 4` instead of `x = 5`, they will see the message, "wrong value for `x`". Finally, notice that you can use Markdown syntax inside the strings here.
 
-The same holds for `test_output_contains()`: you can use the `no_output_msg` argument to specify a custom message. For more information on all the different arguments you can set in the different `pythonwhat` functions, have a look at the articles in this wiki, describing them in detail.
+The same holds for `has_equal_value()`: you can use the `incorrect_msg` argument to specify a custom message. For more information on all the different arguments you can set in the different `pythonwhat` functions, have a look at the articles in this wiki, describing them in detail.
 
 Next Steps
 ----------

docs/source/simple_tests/test_object.md

@@ -97,3 +97,31 @@ Of course primitive classes like `str`, `int`, `list`, `dict`, ... can be tested
 As explained in the [Processes article](../expression_tests.md), objects are extracted from their respected processes by 'dilling' and 'undilling' them. However, you can manually set a 'converter' with the `set_converter()` function. This will override the default dilling and undilling behavior, and enables you to make simplified representations of custom objects, testing only exactly what you want to test.
 
 **NOTE**: Behind the scenes, `pythonwhat` has to fetch the value of objects from sub-processes. The required 'dilling' and 'undilling' can cause issues for exotic objects. For more information on this and possible errors that can occur, read the [Processes article](../expression_tests.md).
+
+check_object
+------------
+
+```eval_rst
+.. autofunction:: pythonwhat.check_object.check_object
+```
+
+is_instance
+-----------
+
+```eval_rst
+.. autofunction:: pythonwhat.check_object.is_instance
+```
+
+has_key
+-----------
+
+```eval_rst
+.. autofunction:: pythonwhat.check_object.has_key
+```
+
+has_equal_key
+---------------
+
+```eval_rst
+.. autofunction:: pythonwhat.check_object.has_equal_key
+```