Skip to content

Commit

Permalink
Cleaning up linting
Browse files Browse the repository at this point in the history
  • Loading branch information
gvwilson committed Jun 5, 2023
1 parent 5113e06 commit f76560f
Show file tree
Hide file tree
Showing 80 changed files with 588 additions and 416 deletions.
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -296,6 +296,6 @@ you will need these packages with `tlmgr` in order to build the PDF:
- `tocbibind`

[diagrams]: https://www.diagrams.net/
[marthas_rules]: https://journals.sagepub.com/doi/10.1177/088610998600100206
[ivy]: https://www.dmulholl.com/docs/ivy/main/
[glosario]: https://glosario.carpentries.org/
[ivy]: https://www.dmulholl.com/docs/ivy/main/
[marthas_rules]: https://journals.sagepub.com/doi/10.1177/088610998600100206
4 changes: 2 additions & 2 deletions LICENSE.md
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

*The Hippocratic License is an [Ethical Source license][ethical_source].*

[udhr]: https://www.un.org/en/universal-declaration-human-rights/
[ethical_source]: https://ethicalsource.dev
[ungc]: https://www.unglobalcompact.org/what-is-gc/mission/principles
[hippocratic_license]: https://firstdonoharm.dev/
[udhr]: https://www.un.org/en/universal-declaration-human-rights/
[ungc]: https://www.unglobalcompact.org/what-is-gc/mission/principles
5 changes: 0 additions & 5 deletions config.py
Original file line number Diff line number Diff line change
Expand Up @@ -81,11 +81,6 @@
"*.xml",
]

# Things to ignore when linting.
unreferenced = [
".pytest_cache/*"
]

# Debug.
debug = False

Expand Down
2 changes: 1 addition & 1 deletion docs/archive/index.html
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-04">
<meta name="build_date" content="2023-06-05">
<meta name="template" content="default">
<meta name="major" content="Chapter 9">
<meta name="has_slides" content="true">
Expand Down
5 changes: 3 additions & 2 deletions docs/archive/slides/index.html
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-04">
<meta name="build_date" content="2023-06-05">
<meta name="template" content="slides">
<meta name="major" content="Chapter 9">

Expand Down Expand Up @@ -412,6 +412,7 @@ <h1>A File Archiver</h1>
[ctan]: https://www.ctan.org/
[cypress]: https://www.cypress.io/
[db_tutorial]: https://cstack.github.io/db_tutorial/
[diagrams]: https://www.diagrams.net/
[dresser_christopher]: https://en.wikipedia.org/wiki/Christopher_Dresser
[ejs]: https://ejs.co/
[email]: mailto:[email protected]
Expand All @@ -424,7 +425,7 @@ <h1>A File Archiver</h1>
[git]: https://git-scm.com/
[git_man_page_generator]: https://git-man-page-generator.lokaltog.net/
[gitlet]: http://gitlet.maryrosecook.com/
[glosario]: https://github.com/carpentries/glosario
[glosario]: https://glosario.carpentries.org/
[gnu_make]: https://www.gnu.org/software/make/
[gutenberg]: https://www.gutenberg.org/
[harrelson_chris]: https://twitter.com/chrishtr
Expand Down
2 changes: 1 addition & 1 deletion docs/bib/index.html
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-04">
<meta name="build_date" content="2023-06-05">
<meta name="template" content="default">
<meta name="major" content="Appendix A">

Expand Down
7 changes: 4 additions & 3 deletions docs/binary/index.html
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-04">
<meta name="build_date" content="2023-06-05">
<meta name="template" content="default">
<meta name="major" content="Chapter 17">
<meta name="has_slides" content="true">
Expand Down Expand Up @@ -347,7 +347,7 @@ <h1>Chapter 17: Binary Data</h1>


<p class="definitions">
Terms defined: <a class="gl-ref" href="../glossary/#absolute_error" markdown="1">absolute error</a>, <a class="gl-ref" href="../glossary/#ansi_encoding" markdown="1">ANSI character encoding</a>, <a class="gl-ref" href="../glossary/#ascii" markdown="1">ASCII character encoding</a>, <a class="gl-ref" href="../glossary/#big_endian" markdown="1">big endian</a>, <a class="gl-ref" href="../glossary/#bit_mask" markdown="1">bit mask</a>, <a class="gl-ref" href="../glossary/#bit_shift" markdown="1">bit shifting</a>, <a class="gl-ref" href="../glossary/#bitwise_operation" markdown="1">bitwise operation</a>, <a class="gl-ref" href="../glossary/#boxed_value" markdown="1">boxed value</a>, <a class="gl-ref" href="../glossary/#code_point" markdown="1">code point</a>, <a class="gl-ref" href="../glossary/#control_code" markdown="1">control code</a>, <a class="gl-ref" href="../glossary/#exclusive_or" markdown="1">exclusive or</a>, <a class="gl-ref" href="../glossary/#exponent" markdown="1">exponent</a>, <a class="gl-ref" href="../glossary/#garbage_collection" markdown="1">garbage collection</a>, <a class="gl-ref" href="../glossary/#hexadecimal" markdown="1">hexadecimal</a>, <a class="gl-ref" href="../glossary/#introspection" markdown="1">introspection</a>, <a class="gl-ref" href="../glossary/#little_endian" markdown="1">little endian</a>, <a class="gl-ref" href="../glossary/#mantissa" markdown="1">mantissa</a>, <a class="gl-ref" href="../glossary/#relative_error" markdown="1">relative error</a>, <a class="gl-ref" href="../glossary/#sign_magnitude" markdown="1">sign and magnitude</a>, <a class="gl-ref" href="../glossary/#twos_complement" markdown="1">two's complement</a>, <a class="gl-ref" href="../glossary/#unicode" markdown="1">Unicode</a>, <a class="gl-ref" href="../glossary/#utf_32" markdown="1">UTF-32</a>, <a class="gl-ref" href="../glossary/#utf_8" markdown="1">UTF-8</a>, <a class="gl-ref" href="../glossary/#variable_length_encoding" markdown="1">variable-length encoding</a>, <a class="gl-ref" href="../glossary/#word_memory" markdown="1">word (of memory)</a>
Terms defined: <a class="gl-ref" href="../glossary/#absolute_error" markdown="1">absolute error</a>, <a class="gl-ref" href="../glossary/#ansi_encoding" markdown="1">ANSI character encoding</a>, <a class="gl-ref" href="../glossary/#ascii" markdown="1">ASCII character encoding</a>, <a class="gl-ref" href="../glossary/#big_endian" markdown="1">big endian</a>, <a class="gl-ref" href="../glossary/#bit_mask" markdown="1">bit mask</a>, <a class="gl-ref" href="../glossary/#bit_shift" markdown="1">bit shifting</a>, <a class="gl-ref" href="../glossary/#bitwise_operation" markdown="1">bitwise operation</a>, <a class="gl-ref" href="../glossary/#boxed_value" markdown="1">boxed value</a>, <a class="gl-ref" href="../glossary/#buffer" markdown="1">buffer</a>, <a class="gl-ref" href="../glossary/#code_point" markdown="1">code point</a>, <a class="gl-ref" href="../glossary/#control_code" markdown="1">control code</a>, <a class="gl-ref" href="../glossary/#exclusive_or" markdown="1">exclusive or</a>, <a class="gl-ref" href="../glossary/#exponent" markdown="1">exponent</a>, <a class="gl-ref" href="../glossary/#garbage_collection" markdown="1">garbage collection</a>, <a class="gl-ref" href="../glossary/#hexadecimal" markdown="1">hexadecimal</a>, <a class="gl-ref" href="../glossary/#introspection" markdown="1">introspection</a>, <a class="gl-ref" href="../glossary/#little_endian" markdown="1">little endian</a>, <a class="gl-ref" href="../glossary/#mantissa" markdown="1">mantissa</a>, <a class="gl-ref" href="../glossary/#relative_error" markdown="1">relative error</a>, <a class="gl-ref" href="../glossary/#sign_magnitude" markdown="1">sign and magnitude</a>, <a class="gl-ref" href="../glossary/#twos_complement" markdown="1">two's complement</a>, <a class="gl-ref" href="../glossary/#unicode" markdown="1">Unicode</a>, <a class="gl-ref" href="../glossary/#utf_32" markdown="1">UTF-32</a>, <a class="gl-ref" href="../glossary/#utf_8" markdown="1">UTF-8</a>, <a class="gl-ref" href="../glossary/#variable_length_encoding" markdown="1">variable-length encoding</a>, <a class="gl-ref" href="../glossary/#word_memory" markdown="1">word (of memory)</a>
</p>


Expand Down Expand Up @@ -985,7 +985,8 @@ <h2 id="binary-binary">Section 17.4: And Now, Persistence</h2>
</code></pre></div>
</div>
<p>The unpacking function is analogous.
We break the buffer into a header that&rsquo;s exactly four bytes long
We break the <a class="gl-ref" href="../glossary/#buffer" markdown="1">buffer</a>
into a header that&rsquo;s exactly four bytes long
(i.e., the right size for an integer)
and a body made up of whatever&rsquo;s left.
We then unpack the header,
Expand Down
5 changes: 3 additions & 2 deletions docs/binary/slides/index.html
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-04">
<meta name="build_date" content="2023-06-05">
<meta name="template" content="slides">
<meta name="major" content="Chapter 17">

Expand Down Expand Up @@ -468,6 +468,7 @@ <h1>Binary Data</h1>
[ctan]: https://www.ctan.org/
[cypress]: https://www.cypress.io/
[db_tutorial]: https://cstack.github.io/db_tutorial/
[diagrams]: https://www.diagrams.net/
[dresser_christopher]: https://en.wikipedia.org/wiki/Christopher_Dresser
[ejs]: https://ejs.co/
[email]: mailto:[email protected]
Expand All @@ -480,7 +481,7 @@ <h1>Binary Data</h1>
[git]: https://git-scm.com/
[git_man_page_generator]: https://git-man-page-generator.lokaltog.net/
[gitlet]: http://gitlet.maryrosecook.com/
[glosario]: https://github.com/carpentries/glosario
[glosario]: https://glosario.carpentries.org/
[gnu_make]: https://www.gnu.org/software/make/
[gutenberg]: https://www.gutenberg.org/
[harrelson_chris]: https://twitter.com/chrishtr
Expand Down
2 changes: 1 addition & 1 deletion docs/build/index.html
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-04">
<meta name="build_date" content="2023-06-05">
<meta name="template" content="default">
<meta name="major" content="Chapter 19">
<meta name="has_slides" content="true">
Expand Down
5 changes: 3 additions & 2 deletions docs/build/slides/index.html
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-04">
<meta name="build_date" content="2023-06-05">
<meta name="template" content="slides">
<meta name="major" content="Chapter 19">

Expand Down Expand Up @@ -424,6 +424,7 @@ <h1>A Build Manager</h1>
[ctan]: https://www.ctan.org/
[cypress]: https://www.cypress.io/
[db_tutorial]: https://cstack.github.io/db_tutorial/
[diagrams]: https://www.diagrams.net/
[dresser_christopher]: https://en.wikipedia.org/wiki/Christopher_Dresser
[ejs]: https://ejs.co/
[email]: mailto:[email protected]
Expand All @@ -436,7 +437,7 @@ <h1>A Build Manager</h1>
[git]: https://git-scm.com/
[git_man_page_generator]: https://git-man-page-generator.lokaltog.net/
[gitlet]: http://gitlet.maryrosecook.com/
[glosario]: https://github.com/carpentries/glosario
[glosario]: https://glosario.carpentries.org/
[gnu_make]: https://www.gnu.org/software/make/
[gutenberg]: https://www.gutenberg.org/
[harrelson_chris]: https://twitter.com/chrishtr
Expand Down
2 changes: 1 addition & 1 deletion docs/check/index.html
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-04">
<meta name="build_date" content="2023-06-05">
<meta name="template" content="default">
<meta name="major" content="Chapter 11">
<meta name="has_slides" content="true">
Expand Down
5 changes: 3 additions & 2 deletions docs/check/slides/index.html
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-04">
<meta name="build_date" content="2023-06-05">
<meta name="template" content="slides">
<meta name="major" content="Chapter 11">

Expand Down Expand Up @@ -459,6 +459,7 @@ <h1>Main Title</h1>
[ctan]: https://www.ctan.org/
[cypress]: https://www.cypress.io/
[db_tutorial]: https://cstack.github.io/db_tutorial/
[diagrams]: https://www.diagrams.net/
[dresser_christopher]: https://en.wikipedia.org/wiki/Christopher_Dresser
[ejs]: https://ejs.co/
[email]: mailto:[email protected]
Expand All @@ -471,7 +472,7 @@ <h1>Main Title</h1>
[git]: https://git-scm.com/
[git_man_page_generator]: https://git-man-page-generator.lokaltog.net/
[gitlet]: http://gitlet.maryrosecook.com/
[glosario]: https://github.com/carpentries/glosario
[glosario]: https://glosario.carpentries.org/
[gnu_make]: https://www.gnu.org/software/make/
[gutenberg]: https://www.gutenberg.org/
[harrelson_chris]: https://twitter.com/chrishtr
Expand Down
2 changes: 1 addition & 1 deletion docs/conduct/index.html
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-04">
<meta name="build_date" content="2023-06-05">
<meta name="template" content="default">
<meta name="major" content="Appendix E">

Expand Down
2 changes: 1 addition & 1 deletion docs/contents/index.html
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-04">
<meta name="build_date" content="2023-06-05">
<meta name="template" content="default">
<meta name="major" content="Appendix I">

Expand Down
9 changes: 2 additions & 7 deletions docs/contrib/index.html
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-04">
<meta name="build_date" content="2023-06-05">
<meta name="template" content="default">
<meta name="major" content="Appendix F">

Expand Down Expand Up @@ -333,7 +333,7 @@ <h1>Appendix F: Contributing</h1>
<p>Contributions are very welcome;
please contact us by email or by filing an issue on this site.
All contributors must abide by our Code of Conduct.</p>
<h2 id="contributing-decisions">Section F.1: Making Decisions</h2>
<h2 id="contrib-decisions">Section F.1: Making Decisions</h2>
<p>This project uses <a href="https://journals.sagepub.com/doi/10.1177/088610998600100206">Martha&rsquo;s Rules</a> for consensus decision making:</p>
<ol>
<li>
Expand Down Expand Up @@ -385,11 +385,6 @@ <h2 id="contributing-decisions">Section F.1: Making Decisions</h2>
the sponsor for further work.</p>
</li>
</ol>
<h2 id="contributing-formatting">Section F.2: Formatting</h2>
<p>This material uses <a href="https://www.dmulholl.com/docs/ivy/main/">Ivy</a> with some custom extensions;
run <code>make</code> in the root directory to get a list of available commands.
Please see <code>CONTRIBUTING.md</code> in the root directory of <a href="https://github.com/gvwilson/sd4ds/">our Git repository</a>
for more information.</p>
</main>
</div>
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/credits/index.html
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-04">
<meta name="build_date" content="2023-06-05">
<meta name="template" content="default">
<meta name="major" content="Appendix H">

Expand Down
2 changes: 1 addition & 1 deletion docs/db/index.html
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-04">
<meta name="build_date" content="2023-06-05">
<meta name="template" content="default">
<meta name="major" content="Chapter 18">
<meta name="has_slides" content="true">
Expand Down
5 changes: 3 additions & 2 deletions docs/db/slides/index.html
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-04">
<meta name="build_date" content="2023-06-05">
<meta name="template" content="slides">
<meta name="major" content="Chapter 18">

Expand Down Expand Up @@ -639,6 +639,7 @@ <h1>A Database</h1>
[ctan]: https://www.ctan.org/
[cypress]: https://www.cypress.io/
[db_tutorial]: https://cstack.github.io/db_tutorial/
[diagrams]: https://www.diagrams.net/
[dresser_christopher]: https://en.wikipedia.org/wiki/Christopher_Dresser
[ejs]: https://ejs.co/
[email]: mailto:[email protected]
Expand All @@ -651,7 +652,7 @@ <h1>A Database</h1>
[git]: https://git-scm.com/
[git_man_page_generator]: https://git-man-page-generator.lokaltog.net/
[gitlet]: http://gitlet.maryrosecook.com/
[glosario]: https://github.com/carpentries/glosario
[glosario]: https://glosario.carpentries.org/
[gnu_make]: https://www.gnu.org/software/make/
[gutenberg]: https://www.gutenberg.org/
[harrelson_chris]: https://twitter.com/chrishtr
Expand Down
2 changes: 1 addition & 1 deletion docs/debugger/index.html
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-04">
<meta name="build_date" content="2023-06-05">
<meta name="template" content="default">
<meta name="major" content="Chapter 26">
<meta name="has_slides" content="true">
Expand Down
5 changes: 3 additions & 2 deletions docs/debugger/slides/index.html
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-04">
<meta name="build_date" content="2023-06-05">
<meta name="template" content="slides">
<meta name="major" content="Chapter 26">

Expand Down Expand Up @@ -495,6 +495,7 @@ <h1>A Debugger</h1>
[ctan]: https://www.ctan.org/
[cypress]: https://www.cypress.io/
[db_tutorial]: https://cstack.github.io/db_tutorial/
[diagrams]: https://www.diagrams.net/
[dresser_christopher]: https://en.wikipedia.org/wiki/Christopher_Dresser
[ejs]: https://ejs.co/
[email]: mailto:[email protected]
Expand All @@ -507,7 +508,7 @@ <h1>A Debugger</h1>
[git]: https://git-scm.com/
[git_man_page_generator]: https://git-man-page-generator.lokaltog.net/
[gitlet]: http://gitlet.maryrosecook.com/
[glosario]: https://github.com/carpentries/glosario
[glosario]: https://glosario.carpentries.org/
[gnu_make]: https://www.gnu.org/software/make/
[gutenberg]: https://www.gutenberg.org/
[harrelson_chris]: https://twitter.com/chrishtr
Expand Down
2 changes: 1 addition & 1 deletion docs/dup/index.html
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-04">
<meta name="build_date" content="2023-06-05">
<meta name="template" content="default">
<meta name="major" content="Chapter 2">
<meta name="has_slides" content="true">
Expand Down
Loading

0 comments on commit f76560f

Please sign in to comment.