plausible first draft!!!!

dham · dham · commit f8ffa804af38 · 2021-11-24T16:37:56.000Z
diff --git a/doc/source/10_further_object-oriented_features.rst b/doc/source/10_further_object-oriented_features.rst
@@ -20,7 +20,7 @@ Decorators
         <https://imperial.cloud.panopto.eu/Panopto/Pages/Viewer.aspx?id=f1d61410-4200-42e5-92c4-acf2011de8ab>`__.
 
 
-In :numref:`Week %s <trees>` we encountered the
+In :numref:`Chapter %s <trees>` we encountered the
 :func:`functools.singledispatch` decorator, which turns a function into a
 :term:`single dispatch function`. More generally, a decorator is a function
 which takes in a function and returns another function. In other words, the
@@ -246,7 +246,7 @@ access features that it provides.
 Abstract methods
 ~~~~~~~~~~~~~~~~
 
-Let's look back at the groups example from :numref:`Week %s <inheritance>`. We
+Let's look back at the groups example from :numref:`Chapter %s <inheritance>`. We
 defined the base :class:`~example_code.groups.Group` class and specified that
 child classes had to implement the :meth:`_validate` and :meth:`operator`
 methods as well as the :attr:`symbol` :term:`class attribute`. But how should
@@ -564,12 +564,19 @@ Glossary
         its definition, but which is instead claimed as a subclass by the
         superclass.
 
-
 Exercises
 ---------
 
-Obtain the `skeleton code for these exercises from GitHub classroom
-<https://classroom.github.com/a/qTArFlxP>`__. 
+.. only:: not book
+
+    Using the information on the `book website 
+    <https://object-oriented-programming.github.io/edition1/exercises.html>`__
+    obtain the skeleton code for these exercises.
+
+.. only:: book
+
+    Using the information on the book website [#exercise_page]_ obtain the
+    skeleton code for these exercises.
 
 .. proof:exercise::
 
@@ -604,4 +611,7 @@ Obtain the `skeleton code for these exercises from GitHub classroom
 
 .. [#python_in_python] Most of the :ref:`Python Standard Library <library-index>` is written
     in Python, so diving in and reading the source code is often an option if
-    you really want to know how some part of the language works.
+    you really want to know how some part of the language works.
+
+.. [#exercise_page] `https://object-oriented-programming.github.io/edition1/exercises.html
+    <https://object-oriented-programming.github.io/edition1/exercises.html>`__
diff --git a/doc/source/1_introduction.rst b/doc/source/1_introduction.rst
@@ -134,7 +134,7 @@ Python you use.
     which were introduced in Python 3.6, so the code will not work in earlier
     versions of Python.
 
-.. _venv:
+.. _create_venv:
 
 Setting up a Python virtual environment
 ---------------------------------------
diff --git a/doc/source/2_programs_in_files.rst b/doc/source/2_programs_in_files.rst
@@ -922,12 +922,14 @@ Glossary
        A text file containing a sequence of Python statements to be
        executed. In Python, program and script are synonymous.
 
+.. _programs_in_files_exercises:
+
 Exercises
 ---------
 
 Before attempting the exercises, ensure that you have obtained the software
 tools described in :numref:`tools` and set up a working folder and
-:term:`virtual environment` as described in :numref:`venv`. If you're not
+:term:`virtual environment` as described in :numref:`create_venv`. If you're not
 already familiar with Git and GitHub then you will also need to work through
 :numref:`Appendix %s <git>` to learn enough to do the exercises.
 
diff --git a/doc/source/6_exceptions.rst b/doc/source/6_exceptions.rst
@@ -195,7 +195,7 @@ level of code either typed directly into iPython or executed in a
 script. However, what happens if an error occurs in a function call or
 even several functions down? Consider the following code, which uses
 the :class:`~polynomial.Polynomial` class from
-:numref:`chapter %s <objects>`:
+:numref:`Chapter %s <objects>`:
 
 .. code-block:: ipython3
 
diff --git a/doc/source/7_inheritance.rst b/doc/source/7_inheritance.rst
@@ -18,7 +18,7 @@ ability to make a complex object or operation out of several components. We can
 compose objects by simply making one object a :term:`attribute` of another
 object. This combines objects in a *has a* relationship. For example the
 :class:`~example_code.polynomial.Polynomial` class introduced in
-:numref:`chapter %s <objects>` *has a* :class:`tuple` of coefficients. Object
+:numref:`Chapter %s <objects>` *has a* :class:`tuple` of coefficients. Object
 composition of this sort is a core part of :term:`encapsulation`.
 
 Another way of composing abstractions is to make a new :term:`class`
@@ -808,9 +808,9 @@ Exercises
     .. hint::
 
         You will need to :keyword:`import` :class:`example_code.groups.Group`
-        from the `object_oriented_programming` repository that you installed
-        :ref:`in Chapter 2 <course_repo>`. You should also `git pull` in that
-        repository in order to get any changes that have happened in the
+        from the `object_oriented_programming` repository that you installed in
+        :numref:`programs_in_files_exercises`. You should also `git pull` in
+        that repository in order to get any changes that have happened in the
         intervening period.
 
     .. hint::
diff --git a/doc/source/8_debugging.rst b/doc/source/8_debugging.rst
@@ -5,7 +5,7 @@ Debugging and testing
 
 In :numref:`Chapter %s <errors_and_exceptions>` we learned about
 :term:`exceptions <exception>` and how to read the :term:`traceback` that is
-printed when an unhandled exception is raised. This week we will look at other
+printed when an unhandled exception is raised. In this chapter we will look at other
 tools and techniques that we can use to understand what is wrong with a piece
 of code, and therefore how to fix it. Before we do that, we'll divert just
 briefly to introduce an important Python module that we'll use in a lot of the
@@ -84,7 +84,7 @@ Observe that the :class:`~pandas.DataFrame` acts as a dictionary of
 one-dimensional data :class:`~pandas.Series`. A :class:`pandas.Series` can be
 indexed and sliced like any other Python :ref:`sequence type <typesseq>`. This
 very high level introduction is all we'll need to use pandas in demonstrations
-this week. Much more documentation is available on the `pandas website <https://pandas.pydata.org/docs/>`__.
+in this chapter. Much more documentation is available on the `pandas website <https://pandas.pydata.org/docs/>`__.
 
 .. note::
 
@@ -120,7 +120,7 @@ advantage that integrates well with IPython. Another advanced command-line
 debugger is `pdb++
 <https://github.com/pdbpp/pdbpp#pdb-a-drop-in-replacement-for-pdb>`__. The
 distinct advantage of pdb++ is that it replaces the built-in pdb. Among other
-things, this means it can be triggered from a failed `pytest
+things, this means it can be triggered from a failed `Pytest
 <https://docs.pytest.org/en/stable/>`__ test. 
 
 The alternative to a command-line debugger is to use a graphical debugger
@@ -650,15 +650,15 @@ and fails if it is.
 Creating a test command
 ~~~~~~~~~~~~~~~~~~~~~~~
 
-Since pytest provides a framework for creating programs which succeed or fail,
+Since Pytest provides a framework for creating programs which succeed or fail,
 one approach is write the test that we wish had existed at the time the bug
 slipped into our code. The bisection search effectively enables us to
 retrospectively introduce this test into our repository. Because we're going to
 be rolling back the state of our repository to before we created this command,
 this is one exception to the rule that you must always commit all of your work
 to the git repository. Make a copy of this command (for example the Python file
-containing the pytest test) outside your repository. For the rest of this
-section, we'll assume that you've created a pytest test in a file called
+containing the Pytest test) outside your repository. For the rest of this
+section, we'll assume that you've created a Pytest test in a file called
 :file:`bug_test.py` which you have placed in the folder containing your
 repository (if you followed the instructions in :numref:`Chapter %s
 <programs_files>` then this folder might be called
@@ -830,49 +830,85 @@ Glossary
 Exercises
 ---------
 
-The exercises work a little differently this week, because the objective is not
-to write code but to practice debugging techniques. The quiz is not on
-BlackBoard but is instead a Google form, because that offers instant feedback.
-You should work through the the exercises and quiz together. For most of exercises,
-there are quiz questions which you will be able to answer if you are
-successfully able to do the exercise.
+.. only:: not book
 
-Obtain the `skeleton code for these exercises from GitHub classroom
-<https://classroom.github.com/a/mi6I-jcG>`__.
+    The exercises work a little differently this week, because the objective is
+    not to write code but to practice debugging techniques. The information on
+    the `book website
+    <https://object-oriented-programming.github.io/edition1/exercises.html>`__
+    points not just to the skeleton code but also to an online quiz which will
+    provide instant feedback on the questions below. You should access the
+    skeleton code and then work through the quiz questions.
 
-.. panels::
-    :card: quiz shadow
+.. only:: book
 
-    .. link-button:: https://forms.gle/cL5eZycNC9Js19uL7
-        :text: This week's quiz
-        :classes: stretched-link 
+    The exercises work a little differently this week, because the objective is
+    not to write code but to practice debugging techniques. The information on
+    the book website [#exercise_page]_
+    points not just to the skeleton code but also to an online quiz which will
+    provide instant feedback on the questions below. You should access the
+    skeleton code and then work through exercises, using the online quiz to
+    check your answers.   
 
 .. proof:exercise:: Debugging python code
 
     The skeleton code contains a Python script :file:`scripts/tests_report`.
-    Run this script under the Visual Studio code debugger and answer the quiz
-    questions about what you find.
+    Run this script under the Visual Studio code debugger and answer the
+    following questions about what you find. Entering the answers into the
+    online quiz will tell you if you are correct.
+
+    1. On which line of the file does the exception occur?
+    2. How many stack frames are there on the call stack when the exception occurs?
+    3. What is the exact value of the variable t?
     
 .. proof:exercise:: Minimal failing example
 
     In the file :file:`scripts/tests_report_mfe.py` construct a :term:`minimal failing
     example` which exhibits the error you discovered in the previous section.
     Your minimal failing example should contain one import and one other line
-    of code. :file:`tests/test_mfe.py` is a pytest test for this exercise.
+    of code. :file:`tests/test_mfe.py` is a Pytest test for this exercise.
+
+.. only:: book
+
+    .. raw:: latex
+
+        \clearpage
 
 .. proof:exercise:: Bisection
 
-    The Unified Form Language (UFL) is a computer symbolic algebra package used to
-    represent partial differential equations in software applying a numerical
-    technique called the finite element method. Clone the `course fork of the
-    UFL repository <https://github.com/object-oriented-python/ufl>`__. At some
-    point in the past, the following code worked:
+    .. only:: not book
+
+        The Unified Form Language (UFL) is a computer symbolic algebra package
+        used to represent partial differential equations in software applying a
+        numerical technique called the finite element method. Clone the `course
+        fork of the UFL repository
+        <https://github.com/object-oriented-python/ufl>`__. At some point in
+        the past, the following code worked:
+
+    .. only:: book
+
+        The Unified Form Language (UFL) is a computer symbolic algebra package
+        used to represent partial differential equations in software applying a
+        numerical technique called the finite element method. Clone the course
+        fork of the UFL repository [#ufl]_. At some point in
+        the past, the following code worked:
 
     .. code-block:: python3
 
         import ufl
         argyris = ufl.FiniteElement("Argyris", degree=6, cell=ufl.triangle)
 
     Use `git bisect` to identify the first commit at which this code failed,
-    and the last commit at which it worked, and answer the corresponding quiz
-    questions.
+    and the last commit at which it worked, and answer the following questions.
+    The online quiz will tell you if you are correct.
+
+    1. What is the commit ID of the first bad commit?
+    2. What is the commit ID of the last good commit?
+
+.. rubric:: Footnotes
+
+.. [#ufl] `https://github.com/object-oriented-python/ufl
+    <https://github.com/object-oriented-python/ufl>`__
+
+.. [#exercise_page] `https://object-oriented-programming.github.io/edition1/exercises.html
+    <https://object-oriented-programming.github.io/edition1/exercises.html>`__
diff --git a/doc/source/9_trees_and_directed_acyclic_graphs.rst b/doc/source/9_trees_and_directed_acyclic_graphs.rst
@@ -1176,19 +1176,35 @@ Glossary
         :func:`functools.singledispatch` function facilitates the creation of
         single dispatch functions.
 
+.. only:: book
+
+    .. raw:: latex
+
+        \clearpage
+
 Exercises
 ---------
 
-Obtain the `skeleton code for these exercises from GitHub classroom
-<https://classroom.github.com/a/DVDJ8r1y>`__. You should also update your clone
-of the course repository to ensure you have the latest version of the
-:mod:`example_code` package.
+.. only:: not book
+
+    Using the information on the `book website 
+    <https://object-oriented-programming.github.io/edition1/exercises.html>`__
+    obtain the skeleton code for these exercises. The exercises also make use
+    of the book repository which you installed in :ref:`in Chapter 2
+    <course_repo>`.
+
+.. only:: book
+
+    Using the information on the book website [#exercise_page]_ obtain the
+    skeleton code for these exercises. The exercises also make use
+    of the book repository which you installed in
+    :numref:`programs_in_files_exercises`.
 
 .. _ex_expr:
 
 .. proof:exercise::
 
-    In the skeleton repository for this week, create a :term:`package`
+    In the exercise repository, create a :term:`package`
     :mod:`expressions` which implements the class hierarchy in
     :numref:`expr_hierarchy`. When implementing :meth:`~object.__str__`, use the
     symbols `+`, `-`, `*`, `/`, and `^`. The names :class:`Symbol`,
@@ -1233,4 +1249,7 @@ of the course repository to ensure you have the latest version of the
     argument, typically the first. Multiple dispatch, in which the function
     implementation is chosen on the basis of multiple function arguments, is
     also possible, and is a key feature of `the Julia programming language
-    <https://julialang.org>`_. 
+    <https://julialang.org>`_. 
+
+.. [#exercise_page] `https://object-oriented-programming.github.io/edition1/exercises.html
+    <https://object-oriented-programming.github.io/edition1/exercises.html>`__
diff --git a/doc/source/a2_git.rst b/doc/source/a2_git.rst
@@ -350,6 +350,11 @@ button marked :kbd:`Create repository from template`.
 
 .. image:: images/github_template.png
 
+.. only:: book
+
+    .. raw:: latex
+
+        \clearpage
 
 .. _exercise_instructions:
 
@@ -365,12 +370,6 @@ this:
 
 .. image:: images/git_exercise.png
 
-.. only:: book
-
-    .. raw:: latex
-
-        \clearpage
-
 So what we have to do is:
 
     1. Edit `exercise.txt` to replace "Hello World" with "Hello Mars!"
