Skip to content

Commit

Permalink
Cleaning up
Browse files Browse the repository at this point in the history
  • Loading branch information
@gvwilson
gvwilson committed Jun 3, 2023
1 parent a0278e2 commit 49f01a8
Show file tree
Hide file tree
Showing 42 changed files with 445 additions and 147 deletions.
11 changes: 7 additions & 4 deletions docs/archive/slides/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="repo" content="https://github.com/gvwilson/sd4ds">
<meta name="build_date" content="2023-06-02">
<meta name="build_date" content="2023-06-03">
<meta name="template" content="slides">
<meta name="major" content="Chapter 9">

Expand Down Expand Up @@ -443,7 +443,6 @@ <h1>A File Archiver</h1>
[lorgat_tutorial]: https://wasimlorgat.com/posts/editor.html
[lorgat_wasim]: https://wasimlorgat.com/
[marthas_rules]: https://journals.sagepub.com/doi/10.1177/088610998600100206
[mkdocs]: https://www.mkdocs.org/
[nison_mael]: https://arcanis.github.io/
[nystrom_bob]: http://journal.stuffwithstuff.com/
[package_manager_tutorial]: https://classic.yarnpkg.com/blog/2017/07/11/lets-dev-a-package-manager/
Expand All @@ -458,36 +457,40 @@ <h1>A File Archiver</h1>
[py_ast]: https://docs.python.org/3/library/ast.html
[py_chainmap]: https://docs.python.org/3/library/collections.html#collections.ChainMap
[py_cprofile]: https://docs.python.org/3/library/profile.html
[py_fractions]: https://docs.python.org/3/library/fractions.html
[py_glob]: https://docs.python.org/3/library/glob.html
[py_hashlib]: https://docs.python.org/3/library/hashlib.html
[py_inspect]: https://docs.python.org/3/library/inspect.html
[py_io]: https://docs.python.org/3/library/io.html
[py_itertools]: https://docs.python.org/3/library/itertools.html
[py_json]: https://docs.python.org/3/library/json.html
[py_jsonschema]: https://python-jsonschema.readthedocs.io/
[py_metaclass]: https://docs.python.org/3/reference/datamodel.html#metaclasses
[py_mimetypes]: https://docs.python.org/3/library/mimetypes.html
[py_pickle]: https://docs.python.org/3/library/pickle.html
[py_property]: https://docs.python.org/3/library/functions.html#property
[py_semver]: https://pypi.org/project/semantic-version/
[py_struct]: https://docs.python.org/3/library/struct.html
[py_textwrap]: https://docs.python.org/3/library/textwrap.html
[py_urlparse]: https://docs.python.org/3/library/urllib.parse.html
[pyfakefs]: https://pytest-pyfakefs.readthedocs.io/
[pytest]: https://docs.pytest.org/
[pytest_approx]: https://docs.pytest.org/en/4.6.x/reference.html#pytest-approx
[python]: https://www.python.org/
[reim_michael]: https://elderlinux.org/
[requests]: https://requests.readthedocs.io/
[ruten_paige]: https://viewsourcecode.org/
[selenium]: https://www.selenium.dev/
[semver_spec]: https://semver.org/
[sinel_joseph]: https://en.wikipedia.org/wiki/Joseph_Claude_Sinel
[sphinx]: https://www.sphinx-doc.org/
[snakemake]: https://snakemake.readthedocs.io/
[sqlite]: https://sqlite.org/
[stack_connor]: https://connorstack.com/
[svg_screenshot]: https://chrome.google.com/webstore/detail/svg-screenshot/nfakpcpmhhilkdpphcjgnokknpbpdllg
[t3_personas]: https://teachtogether.tech/en/index.html#s:process-personas
[textualize_fraction]: https://www.textualize.io/blog/posts/7-things-about-terminals
[udhr]: https://www.un.org/en/universal-declaration-human-rights/
[ungc]: https://www.unglobalcompact.org/what-is-gc/mission/principles
[unicode]: https://www.unicode.org/
[unix_glob]: https://en.wikipedia.org/wiki/Glob_(programming)
[unix_packaging]: https://eerielinux.wordpress.com/2017/08/15/the-history-of-nix-package-management/
[webaim_wave]: https://wave.webaim.org/
Expand Down
14 changes: 7 additions & 7 deletions docs/binary/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="repo" content="https://github.com/gvwilson/sd4ds">
<meta name="build_date" content="2023-06-02">
<meta name="build_date" content="2023-06-03">
<meta name="template" content="default">
<meta name="major" content="Chapter 17">
<meta name="has_slides" content="true">
Expand Down Expand Up @@ -675,7 +675,7 @@ <h2 id="binary-text">Section 17.3: Text</h2>
U+0065 for an upper-case Latin &ldquo;A&rdquo;,
U+2605 for a black star,
and so on.
(The [Unicode Consortium site][unicode] offers a complete list.)</p>
(The <a href="https://www.unicode.org/">Unicode Consortium site</a> offers a complete list.)</p>
<p>The second part defined ways to store these values in memory.
The simplest of these is <a class="gl-ref" href="../glossary/#utf_32" markdown="1">UTF-32</a>,
which stores every character as a 32-bit number.
Expand Down Expand Up @@ -838,7 +838,7 @@ <h2 id="binary-binary">Section 17.4: And Now, Persistence</h2>
<figcaption markdown="1">Figure 17.3: Packing and unpacking binary values.</figcaption>
</figure>

<p>Python&rsquo;s [struct][py_struct] module packs and unpacks data for us.
<p>Python&rsquo;s <a href="https://docs.python.org/3/library/struct.html">struct</a> module packs and unpacks data for us.
The function <code>pack(format, val_1, val_2, …)</code>
takes a format string and a bunch of values as arguments
and packs them into a <code>bytes</code> object.
Expand Down Expand Up @@ -1173,13 +1173,13 @@ <h3>Go To the Source</h3>
though,
since they don&rsquo;t depend on being the same down to the last bit.</p>
<p>If we do want to compare floating point numbers
we can use something like [the <code>approx</code> class][pytest_approx] from <a href="https://docs.pytest.org/">pytest</a>
we can use something like <a href="https://docs.pytest.org/en/4.6.x/reference.html#pytest-approx">the <code>approx</code> class</a> from <a href="https://docs.pytest.org/">pytest</a>
which checks whether two numbers are within some tolerance of each other.
A completely different approach is to use something like
the [fractions][py_fractions] module,
the <a href="https://docs.python.org/3/library/fractions.html">fractions</a> module,
which (as its name suggests) uses numerators and denominators
to avoid some precision issues.
[This post][textualize_fraction] describes one clever use of the module.</p>
<a href="https://www.textualize.io/blog/posts/7-things-about-terminals">This post</a> describes one clever use of the module.</p>
<h2 id="binary-summary">Section 17.6: Summary</h2>
<figure id="binary-concept-map">
<img src="./concept_map.svg" alt="Concept map for binary data"/>
Expand Down Expand Up @@ -1237,7 +1237,7 @@ <h3 class="exercise">Roundoff</h3>
<li>Calculate the absolute and relative differences between corresponding values
(which should be identical).</li>
<li>Repeat the exercise using the <code>Fraction</code> class
from the [fractions][py_fractions] module.</li>
from the <a href="https://docs.python.org/3/library/fractions.html">fractions</a> module.</li>
</ol>
</main>
</div>
Expand Down
11 changes: 7 additions & 4 deletions docs/binary/slides/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="repo" content="https://github.com/gvwilson/sd4ds">
<meta name="build_date" content="2023-06-02">
<meta name="build_date" content="2023-06-03">
<meta name="template" content="slides">
<meta name="major" content="Chapter 17">

Expand Down Expand Up @@ -499,7 +499,6 @@ <h1>Binary Data</h1>
[lorgat_tutorial]: https://wasimlorgat.com/posts/editor.html
[lorgat_wasim]: https://wasimlorgat.com/
[marthas_rules]: https://journals.sagepub.com/doi/10.1177/088610998600100206
[mkdocs]: https://www.mkdocs.org/
[nison_mael]: https://arcanis.github.io/
[nystrom_bob]: http://journal.stuffwithstuff.com/
[package_manager_tutorial]: https://classic.yarnpkg.com/blog/2017/07/11/lets-dev-a-package-manager/
Expand All @@ -514,36 +513,40 @@ <h1>Binary Data</h1>
[py_ast]: https://docs.python.org/3/library/ast.html
[py_chainmap]: https://docs.python.org/3/library/collections.html#collections.ChainMap
[py_cprofile]: https://docs.python.org/3/library/profile.html
[py_fractions]: https://docs.python.org/3/library/fractions.html
[py_glob]: https://docs.python.org/3/library/glob.html
[py_hashlib]: https://docs.python.org/3/library/hashlib.html
[py_inspect]: https://docs.python.org/3/library/inspect.html
[py_io]: https://docs.python.org/3/library/io.html
[py_itertools]: https://docs.python.org/3/library/itertools.html
[py_json]: https://docs.python.org/3/library/json.html
[py_jsonschema]: https://python-jsonschema.readthedocs.io/
[py_metaclass]: https://docs.python.org/3/reference/datamodel.html#metaclasses
[py_mimetypes]: https://docs.python.org/3/library/mimetypes.html
[py_pickle]: https://docs.python.org/3/library/pickle.html
[py_property]: https://docs.python.org/3/library/functions.html#property
[py_semver]: https://pypi.org/project/semantic-version/
[py_struct]: https://docs.python.org/3/library/struct.html
[py_textwrap]: https://docs.python.org/3/library/textwrap.html
[py_urlparse]: https://docs.python.org/3/library/urllib.parse.html
[pyfakefs]: https://pytest-pyfakefs.readthedocs.io/
[pytest]: https://docs.pytest.org/
[pytest_approx]: https://docs.pytest.org/en/4.6.x/reference.html#pytest-approx
[python]: https://www.python.org/
[reim_michael]: https://elderlinux.org/
[requests]: https://requests.readthedocs.io/
[ruten_paige]: https://viewsourcecode.org/
[selenium]: https://www.selenium.dev/
[semver_spec]: https://semver.org/
[sinel_joseph]: https://en.wikipedia.org/wiki/Joseph_Claude_Sinel
[sphinx]: https://www.sphinx-doc.org/
[snakemake]: https://snakemake.readthedocs.io/
[sqlite]: https://sqlite.org/
[stack_connor]: https://connorstack.com/
[svg_screenshot]: https://chrome.google.com/webstore/detail/svg-screenshot/nfakpcpmhhilkdpphcjgnokknpbpdllg
[t3_personas]: https://teachtogether.tech/en/index.html#s:process-personas
[textualize_fraction]: https://www.textualize.io/blog/posts/7-things-about-terminals
[udhr]: https://www.un.org/en/universal-declaration-human-rights/
[ungc]: https://www.unglobalcompact.org/what-is-gc/mission/principles
[unicode]: https://www.unicode.org/
[unix_glob]: https://en.wikipedia.org/wiki/Glob_(programming)
[unix_packaging]: https://eerielinux.wordpress.com/2017/08/15/the-history-of-nix-package-management/
[webaim_wave]: https://wave.webaim.org/
Expand Down
4 changes: 2 additions & 2 deletions docs/build/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="repo" content="https://github.com/gvwilson/sd4ds">
<meta name="build_date" content="2023-06-02">
<meta name="build_date" content="2023-06-03">
<meta name="template" content="default">
<meta name="major" content="Chapter 19">
<meta name="has_slides" content="true">
Expand Down Expand Up @@ -358,7 +358,7 @@ <h1>Chapter 19: A Build Manager</h1>
to keep track of which files depend on which
and what actions to take to create or update files.
The first tool of this kind was <a href="https://www.gnu.org/software/make/">Make</a>,
but many others now exist (such as [Snakemake][snakemake]).
but many others now exist (such as <a href="https://snakemake.readthedocs.io/">Snakemake</a>).
If a <a class="gl-ref" href="../glossary/#build_target" markdown="1">target</a> is <a class="gl-ref" href="../glossary/#build_stale" markdown="1">stale</a>
with respect to any of its <a class="gl-ref" href="../glossary/#dependency" markdown="1">dependencies</a>,
the builder manager runs a <a class="gl-ref" href="../glossary/#build_recipe" markdown="1">recipe</a> to refresh it.</p>
Expand Down
11 changes: 7 additions & 4 deletions docs/build/slides/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="repo" content="https://github.com/gvwilson/sd4ds">
<meta name="build_date" content="2023-06-02">
<meta name="build_date" content="2023-06-03">
<meta name="template" content="slides">
<meta name="major" content="Chapter 19">

Expand Down Expand Up @@ -455,7 +455,6 @@ <h1>A Build Manager</h1>
[lorgat_tutorial]: https://wasimlorgat.com/posts/editor.html
[lorgat_wasim]: https://wasimlorgat.com/
[marthas_rules]: https://journals.sagepub.com/doi/10.1177/088610998600100206
[mkdocs]: https://www.mkdocs.org/
[nison_mael]: https://arcanis.github.io/
[nystrom_bob]: http://journal.stuffwithstuff.com/
[package_manager_tutorial]: https://classic.yarnpkg.com/blog/2017/07/11/lets-dev-a-package-manager/
Expand All @@ -470,36 +469,40 @@ <h1>A Build Manager</h1>
[py_ast]: https://docs.python.org/3/library/ast.html
[py_chainmap]: https://docs.python.org/3/library/collections.html#collections.ChainMap
[py_cprofile]: https://docs.python.org/3/library/profile.html
[py_fractions]: https://docs.python.org/3/library/fractions.html
[py_glob]: https://docs.python.org/3/library/glob.html
[py_hashlib]: https://docs.python.org/3/library/hashlib.html
[py_inspect]: https://docs.python.org/3/library/inspect.html
[py_io]: https://docs.python.org/3/library/io.html
[py_itertools]: https://docs.python.org/3/library/itertools.html
[py_json]: https://docs.python.org/3/library/json.html
[py_jsonschema]: https://python-jsonschema.readthedocs.io/
[py_metaclass]: https://docs.python.org/3/reference/datamodel.html#metaclasses
[py_mimetypes]: https://docs.python.org/3/library/mimetypes.html
[py_pickle]: https://docs.python.org/3/library/pickle.html
[py_property]: https://docs.python.org/3/library/functions.html#property
[py_semver]: https://pypi.org/project/semantic-version/
[py_struct]: https://docs.python.org/3/library/struct.html
[py_textwrap]: https://docs.python.org/3/library/textwrap.html
[py_urlparse]: https://docs.python.org/3/library/urllib.parse.html
[pyfakefs]: https://pytest-pyfakefs.readthedocs.io/
[pytest]: https://docs.pytest.org/
[pytest_approx]: https://docs.pytest.org/en/4.6.x/reference.html#pytest-approx
[python]: https://www.python.org/
[reim_michael]: https://elderlinux.org/
[requests]: https://requests.readthedocs.io/
[ruten_paige]: https://viewsourcecode.org/
[selenium]: https://www.selenium.dev/
[semver_spec]: https://semver.org/
[sinel_joseph]: https://en.wikipedia.org/wiki/Joseph_Claude_Sinel
[sphinx]: https://www.sphinx-doc.org/
[snakemake]: https://snakemake.readthedocs.io/
[sqlite]: https://sqlite.org/
[stack_connor]: https://connorstack.com/
[svg_screenshot]: https://chrome.google.com/webstore/detail/svg-screenshot/nfakpcpmhhilkdpphcjgnokknpbpdllg
[t3_personas]: https://teachtogether.tech/en/index.html#s:process-personas
[textualize_fraction]: https://www.textualize.io/blog/posts/7-things-about-terminals
[udhr]: https://www.un.org/en/universal-declaration-human-rights/
[ungc]: https://www.unglobalcompact.org/what-is-gc/mission/principles
[unicode]: https://www.unicode.org/
[unix_glob]: https://en.wikipedia.org/wiki/Glob_(programming)
[unix_packaging]: https://eerielinux.wordpress.com/2017/08/15/the-history-of-nix-package-management/
[webaim_wave]: https://wave.webaim.org/
Expand Down
11 changes: 7 additions & 4 deletions docs/check/slides/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="repo" content="https://github.com/gvwilson/sd4ds">
<meta name="build_date" content="2023-06-02">
<meta name="build_date" content="2023-06-03">
<meta name="template" content="slides">
<meta name="major" content="Chapter 11">

Expand Down Expand Up @@ -490,7 +490,6 @@ <h1>Main Title</h1>
[lorgat_tutorial]: https://wasimlorgat.com/posts/editor.html
[lorgat_wasim]: https://wasimlorgat.com/
[marthas_rules]: https://journals.sagepub.com/doi/10.1177/088610998600100206
[mkdocs]: https://www.mkdocs.org/
[nison_mael]: https://arcanis.github.io/
[nystrom_bob]: http://journal.stuffwithstuff.com/
[package_manager_tutorial]: https://classic.yarnpkg.com/blog/2017/07/11/lets-dev-a-package-manager/
Expand All @@ -505,36 +504,40 @@ <h1>Main Title</h1>
[py_ast]: https://docs.python.org/3/library/ast.html
[py_chainmap]: https://docs.python.org/3/library/collections.html#collections.ChainMap
[py_cprofile]: https://docs.python.org/3/library/profile.html
[py_fractions]: https://docs.python.org/3/library/fractions.html
[py_glob]: https://docs.python.org/3/library/glob.html
[py_hashlib]: https://docs.python.org/3/library/hashlib.html
[py_inspect]: https://docs.python.org/3/library/inspect.html
[py_io]: https://docs.python.org/3/library/io.html
[py_itertools]: https://docs.python.org/3/library/itertools.html
[py_json]: https://docs.python.org/3/library/json.html
[py_jsonschema]: https://python-jsonschema.readthedocs.io/
[py_metaclass]: https://docs.python.org/3/reference/datamodel.html#metaclasses
[py_mimetypes]: https://docs.python.org/3/library/mimetypes.html
[py_pickle]: https://docs.python.org/3/library/pickle.html
[py_property]: https://docs.python.org/3/library/functions.html#property
[py_semver]: https://pypi.org/project/semantic-version/
[py_struct]: https://docs.python.org/3/library/struct.html
[py_textwrap]: https://docs.python.org/3/library/textwrap.html
[py_urlparse]: https://docs.python.org/3/library/urllib.parse.html
[pyfakefs]: https://pytest-pyfakefs.readthedocs.io/
[pytest]: https://docs.pytest.org/
[pytest_approx]: https://docs.pytest.org/en/4.6.x/reference.html#pytest-approx
[python]: https://www.python.org/
[reim_michael]: https://elderlinux.org/
[requests]: https://requests.readthedocs.io/
[ruten_paige]: https://viewsourcecode.org/
[selenium]: https://www.selenium.dev/
[semver_spec]: https://semver.org/
[sinel_joseph]: https://en.wikipedia.org/wiki/Joseph_Claude_Sinel
[sphinx]: https://www.sphinx-doc.org/
[snakemake]: https://snakemake.readthedocs.io/
[sqlite]: https://sqlite.org/
[stack_connor]: https://connorstack.com/
[svg_screenshot]: https://chrome.google.com/webstore/detail/svg-screenshot/nfakpcpmhhilkdpphcjgnokknpbpdllg
[t3_personas]: https://teachtogether.tech/en/index.html#s:process-personas
[textualize_fraction]: https://www.textualize.io/blog/posts/7-things-about-terminals
[udhr]: https://www.un.org/en/universal-declaration-human-rights/
[ungc]: https://www.unglobalcompact.org/what-is-gc/mission/principles
[unicode]: https://www.unicode.org/
[unix_glob]: https://en.wikipedia.org/wiki/Glob_(programming)
[unix_packaging]: https://eerielinux.wordpress.com/2017/08/15/the-history-of-nix-package-management/
[webaim_wave]: https://wave.webaim.org/
Expand Down
Loading

0 comments on commit 49f01a8

Please sign in to comment.