Skip to content

Commit ac40f02

Browse files
committed
doc updates
1 parent 5522bae commit ac40f02

6 files changed

Lines changed: 41 additions & 22 deletions

File tree

docs/source/Home.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,8 @@
1-
Home
2-
====
1+
Background
2+
==========
33

4-
At DataCamp we build tools to [learn data science](https://www.datacamp.com) interactively. See e.g. our online [R tutorial](https://www.datacamp.com/courses/free-introduction-to-r) to learn R Programming and our Python For Data Science tutorial to [learn Python](https://www.datacamp.com/courses/intro-to-python-for-data-science).
5-
6-
pythonwhat?
7-
-----------
4+
What is pythonwhat?
5+
-------------------
86

97
A major part of DataCamp's interactive learning is centered around automated and meaningful feedback. When a student submits an incorrect answer, the system tells the student what he or she is doing wrong. This happens through so-called submission correctness tests, or SCTs. An SCT is a test script that compares the different steps in a student's submission to the ideal solution, and generates meaningful feedback along the way.
108

docs/source/index.rst

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,38 @@
11
pythonwhat
22
================================================
33

4-
Contents:
5-
---------
4+
At DataCamp we build tools to `learn data science <https://www.datacamp.com>`_ interactively.
5+
See e.g. our online `R tutorial <https://www.datacamp.com/courses/free-introduction-to-r>`_ to learn R Programming and our Python For Data Science tutorial to `learn Python <https://www.datacamp.com/courses/intro-to-python-for-data-science>`_.
6+
7+
To jump in to pythonwhat, check out the `Interactive Examples <https://datacamp.github.io/courses-pythonwhat-tutorial>`_ and the :doc:`Quickstart Guide <quickstart_guide>`.
8+
69

710
.. toctree::
11+
:hidden:
812
:maxdepth: 2
13+
:caption: General
914

1015
Home
1116
quickstart_guide
17+
interactive_examples
18+
19+
20+
.. toctree::
21+
:hidden:
22+
:maxdepth: 2
23+
:caption: API
24+
1225
simple_tests/index.rst
1326
part_checks
1427
expression_tests
1528
logic_tests/index.rst
16-
spec2_summary
1729

1830

19-
Pythonwhat V1
20-
-------------
21-
2231
.. toctree::
32+
:hidden:
33+
:caption: Upgrading from v1
2334

35+
spec2_summary
2436
pythonwhat.wiki/index.rst
2537

2638

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
Interactive Examples
2+
====================
3+
4+
Click `here <https://datacamp.github.io/courses-pythonwhat-tutorial>`_ for walkthrough
5+
made up of interactive exercises.
6+
7+
In order to raise issues or make changes to the walkthrough, see the
8+
`courses-pythonwhat-tutorial <https://github.com/datacamp/courses-pythonwhat-tutorial>`_ github repo.

docs/source/logic_tests/index.rst

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,13 @@
11
Logic Tests
22
===========
33

4+
These tests are used to combine different SCTs. For example, ``test_or`` takes
5+
one or more SCTs, and fails only if all of those SCTs fail.
6+
47
.. toctree::
58
:maxdepth: 2
9+
:hidden:
610

711
test_correct
812
test_or
9-
test_no
13+
test_not

docs/source/simple_tests/index.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,12 @@ Simple Tests
22
============
33

44
Simple tests are the most basic tests available in pythonwhat.
5-
They usually don't focus on specific pieces of a submission (:doc:`like part checks </part_checks.rst>`), or re-run any code (:doc:`like expression tests </expression_tests.md>).
5+
They usually don't focus on specific pieces of a submission (:doc:`like part checks <part_checks`), or re-run any code (:doc:`like expression tests <expressions>`).
66
Instead, they simply look at things like imports, printed output, or raw code text.
77
A final, common use is to test the value of a variable in the final environment (that is, after the submission of solution code have been run).
88

99
.. toctree::
10+
:hidden:
1011
:maxdepth: 2
1112

1213
test_import

docs/source/simple_tests/test_object.md

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -98,29 +98,25 @@ As explained in the [Processes article](../expression_tests.md), objects are ext
9898

9999
**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).
100100

101-
check_object
102-
------------
101+
### check_object syntax
103102

104103
```eval_rst
105104
.. autofunction:: pythonwhat.check_object.check_object
106105
```
107106

108-
is_instance
109-
-----------
107+
#### is_instance
110108

111109
```eval_rst
112110
.. autofunction:: pythonwhat.check_object.is_instance
113111
```
114112

115-
has_key
116-
-----------
113+
#### has_key
117114

118115
```eval_rst
119116
.. autofunction:: pythonwhat.check_object.has_key
120117
```
121118

122-
has_equal_key
123-
---------------
119+
#### has_equal_key
124120

125121
```eval_rst
126122
.. autofunction:: pythonwhat.check_object.has_equal_key

0 commit comments

Comments
 (0)