Website build

Author: dham

3_objects.html

@@ -602,7 +602,7 @@ <h3><span class="section-number">3.3.4. </span>String representations of objects
 <span id="object-arithmetic"></span><h3><span class="section-number">3.3.6. </span>Defining arithmetic options on objects<a class="headerlink" href="#defining-arithmetic-options-on-objects" title="Permalink to this headline">¶</a></h3>
 <details class="sphinx-bs dropdown card mb-3">
 <summary class="summary-title card-header">
-Video: object equality and test driven development<div class="summary-down docutils">
+Video: polynomial addition.<div class="summary-down docutils">
 <svg version="1.1" width="24" height="24" class="octicon octicon-chevron-down" viewBox="0 0 24 24" aria-hidden="true"><path fill-rule="evenodd" d="M5.22 8.72a.75.75 0 000 1.06l6.25 6.25a.75.75 0 001.06 0l6.25-6.25a.75.75 0 00-1.06-1.06L12 14.44 6.28 8.72a.75.75 0 00-1.06 0z"></path></svg></div>
 <div class="summary-up docutils">
 <svg version="1.1" width="24" height="24" class="octicon octicon-chevron-up" viewBox="0 0 24 24" aria-hidden="true"><path fill-rule="evenodd" d="M18.78 15.28a.75.75 0 000-1.06l-6.25-6.25a.75.75 0 00-1.06 0l-6.25 6.25a.75.75 0 101.06 1.06L12 9.56l5.72 5.72a.75.75 0 001.06 0z"></path></svg></div>

4_style.html

@@ -53,7 +53,20 @@
 
   <div class="section" id="a-matter-of-style">
 <span id="style"></span><h1><span class="section-number">4. </span>A matter of style<a class="headerlink" href="#a-matter-of-style" title="Permalink to this headline">¶</a></h1>
-<div class="section" id="the-value-of-convention">
+<details class="sphinx-bs dropdown card mb-3">
+<summary class="summary-title card-header">
+Video: why style?<div class="summary-down docutils">
+<svg version="1.1" width="24" height="24" class="octicon octicon-chevron-down" viewBox="0 0 24 24" aria-hidden="true"><path fill-rule="evenodd" d="M5.22 8.72a.75.75 0 000 1.06l6.25 6.25a.75.75 0 001.06 0l6.25-6.25a.75.75 0 00-1.06-1.06L12 14.44 6.28 8.72a.75.75 0 00-1.06 0z"></path></svg></div>
+<div class="summary-up docutils">
+<svg version="1.1" width="24" height="24" class="octicon octicon-chevron-up" viewBox="0 0 24 24" aria-hidden="true"><path fill-rule="evenodd" d="M18.78 15.28a.75.75 0 000-1.06l-6.25-6.25a.75.75 0 00-1.06 0l-6.25 6.25a.75.75 0 101.06 1.06L12 9.56l5.72 5.72a.75.75 0 001.06 0z"></path></svg></div>
+</summary><div class="summary-content card-body docutils">
+<div class="vimeo docutils container">
+<iframe src="https://player.vimeo.com/video/499766703"
+frameborder="0" allow="autoplay; fullscreen"
+allowfullscreen></iframe></div>
+<p class="card-text">Imperial students can also <a class="reference external" href="https://imperial.cloud.panopto.eu/Panopto/Pages/Viewer.aspx?id=3572d8ea-5635-4b1a-9243-acae0150ddf8">watch this video on Panopto</a></p>
+</div>
+</details><div class="section" id="the-value-of-convention">
 <h2><span class="section-number">4.1. </span>The value of convention<a class="headerlink" href="#the-value-of-convention" title="Permalink to this headline">¶</a></h2>
 <p>Consider the following definition of the limit of a function <span class="math notranslate nohighlight">\(f\)</span> at a point <span class="math notranslate nohighlight">\(c\)</span>:</p>
 <div class="proof proof-type-definition" id="id3">
@@ -139,7 +152,20 @@ <h2><span class="section-number">4.2. </span>PEP 8<a class="headerlink" href="#p
 with code layout rules while this chapter roams more widely.</p>
 <div class="section" id="linters">
 <h3><span class="section-number">4.2.1. </span>Linters<a class="headerlink" href="#linters" title="Permalink to this headline">¶</a></h3>
-<p>One of the helpful characteristics of PEP 8 is that many of its strictures can
+<details class="sphinx-bs dropdown card mb-3">
+<summary class="summary-title card-header">
+Video: installing and using a linter.<div class="summary-down docutils">
+<svg version="1.1" width="24" height="24" class="octicon octicon-chevron-down" viewBox="0 0 24 24" aria-hidden="true"><path fill-rule="evenodd" d="M5.22 8.72a.75.75 0 000 1.06l6.25 6.25a.75.75 0 001.06 0l6.25-6.25a.75.75 0 00-1.06-1.06L12 14.44 6.28 8.72a.75.75 0 00-1.06 0z"></path></svg></div>
+<div class="summary-up docutils">
+<svg version="1.1" width="24" height="24" class="octicon octicon-chevron-up" viewBox="0 0 24 24" aria-hidden="true"><path fill-rule="evenodd" d="M18.78 15.28a.75.75 0 000-1.06l-6.25-6.25a.75.75 0 00-1.06 0l-6.25 6.25a.75.75 0 101.06 1.06L12 9.56l5.72 5.72a.75.75 0 001.06 0z"></path></svg></div>
+</summary><div class="summary-content card-body docutils">
+<div class="vimeo docutils container">
+<iframe src="https://player.vimeo.com/video/499770130"
+frameborder="0" allow="autoplay; fullscreen"
+allowfullscreen></iframe></div>
+<p class="card-text">Imperial students can also <a class="reference external" href="https://imperial.cloud.panopto.eu/Panopto/Pages/Viewer.aspx?id=91c271e4-a61f-493c-a725-acae015273d5">watch this video on Panopto</a></p>
+</div>
+</details><p>One of the helpful characteristics of PEP 8 is that many of its strictures can
 be enforced automatically by a computer program. Programs that automatically
 check programming style are called linters. Lint are the little fibres that tend
 to stick to clothes, especially suit jackets, and make them ugly. So a linter is
@@ -158,6 +184,20 @@ <h3><span class="section-number">4.2.1. </span>Linters<a class="headerlink" href
 tendency for programmers to cut style corners, with the effect that
 the code in a project becomes harder and harder to read and work with.</p>
 </div>
+<div class="section" id="installing-flake8">
+<h3><span class="section-number">4.2.2. </span>Installing flake8<a class="headerlink" href="#installing-flake8" title="Permalink to this headline">¶</a></h3>
+<p>Flake8 is a Python package, which can be installed using pip. Make sure you’ve
+activated your <a class="reference internal" href="2_programs_in_files.html#term-virtual-environment"><span class="xref std std-term">virtual environment</span></a> and then run:</p>
+<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$</span> python3 -m pip install flake8
+</pre></div>
+</div>
+<p>This is enough to run flake8 on the command line, however you will probably want
+to set up your editor to highlight flake8 incompatibilities in your source. For
+visual studio code, first open the command palette by typing <kbd class="kbd docutils literal notranslate">control</kbd> +
+<kbd class="kbd docutils literal notranslate">shift</kbd> + <kbd class="kbd docutils literal notranslate">P</kbd> (<kbd class="kbd docutils literal notranslate">⌘</kbd> + <kbd class="kbd docutils literal notranslate">shift</kbd> + <kbd class="kbd docutils literal notranslate">P</kbd> on Mac). There type
+“Python: Select Linter” to bring up the list of available linters, and select
+“flake8” from the dropdown list. The video above shows this process.</p>
+</div>
 </div>
 <div class="section" id="code-layout">
 <h2><span class="section-number">4.3. </span>Code layout<a class="headerlink" href="#code-layout" title="Permalink to this headline">¶</a></h2>
@@ -948,7 +988,11 @@ <h2><span class="section-number">4.9. </span>Exercises<a class="headerlink" href
         <span class="proof-type">Exercise 4.2</span>
 
     </div><div class="proof-content">
-<p>Configure your Python editor to use flake8.</p>
+<p>Install flake8 and configure your Python editor to use flake8.</p>
+<div class="admonition note">
+<p class="admonition-title">Note</p>
+<p>The test should check that flake8 is importable.</p>
+</div>
 </div></div><div class="admonition note">
 <p class="admonition-title">Note</p>
 <p>Use this example in the exercises or quiz:</p>

_sources/3_objects.rst.txt

@@ -600,7 +600,7 @@ equality now behaves as we might expect.
 Defining arithmetic options on objects
 ......................................
 
-.. dropdown:: Video: object equality and test driven development
+.. dropdown:: Video: polynomial addition.
 
     .. container:: vimeo
 

_sources/4_style.rst.txt

@@ -3,6 +3,20 @@
 A matter of style
 =================
 
+.. dropdown:: Video: why style?
+
+    .. container:: vimeo
+
+        .. raw:: html
+
+            <iframe src="https://player.vimeo.com/video/499766703"
+            frameborder="0" allow="autoplay; fullscreen"
+            allowfullscreen></iframe>
+
+    Imperial students can also `watch this video on Panopto
+    <https://imperial.cloud.panopto.eu/Panopto/Pages/Viewer.aspx?id=3572d8ea-5635-4b1a-9243-acae0150ddf8>`__
+
+
 The value of convention
 -----------------------
 
@@ -97,6 +111,20 @@ with code layout rules while this chapter roams more widely.
 Linters
 .......
 
+.. dropdown:: Video: installing and using a linter.
+
+    .. container:: vimeo
+
+        .. raw:: html
+
+            <iframe src="https://player.vimeo.com/video/499770130"
+            frameborder="0" allow="autoplay; fullscreen"
+            allowfullscreen></iframe>
+
+    Imperial students can also `watch this video on Panopto
+    <https://imperial.cloud.panopto.eu/Panopto/Pages/Viewer.aspx?id=91c271e4-a61f-493c-a725-acae015273d5>`__
+
+
 One of the helpful characteristics of PEP 8 is that many of its strictures can
 be enforced automatically by a computer program. Programs that automatically
 check programming style are called linters. Lint are the little fibres that tend
@@ -118,6 +146,23 @@ conformance. Indeed, without a mechanism like this, there is a strong
 tendency for programmers to cut style corners, with the effect that
 the code in a project becomes harder and harder to read and work with.
 
+Installing flake8
+.................
+
+Flake8 is a Python package, which can be installed using pip. Make sure you've
+activated your :term:`virtual environment` and then run:
+
+.. code-block:: console
+
+    $ python3 -m pip install flake8
+
+This is enough to run flake8 on the command line, however you will probably want
+to set up your editor to highlight flake8 incompatibilities in your source. For
+visual studio code, first open the command palette by typing :kbd:`control` +
+:kbd:`shift` + :kbd:`P` (:kbd:`⌘` + :kbd:`shift` + :kbd:`P` on Mac). There type
+"Python: Select Linter" to bring up the list of available linters, and select
+"flake8" from the dropdown list. The video above shows this process.
+
 Code layout
 -----------
 
@@ -978,8 +1023,11 @@ Exercises
 
 .. proof:exercise::
 
-    Configure your Python editor to use flake8.
+    Install flake8 and configure your Python editor to use flake8.
 
+    .. note:: 
+    
+        The test should check that flake8 is importable.
 
 .. note::