Skip to content

Commit adbc9d8

Browse files
committed
Fixing a few FIXMEs.
1 parent d7bd218 commit adbc9d8

File tree

12 files changed

+109
-31
lines changed

12 files changed

+109
-31
lines changed

Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ HOME_PAGE=${SITE}/index.html
1818
INDEX_YML=_data/index.yml
1919
NUM_YML=_data/numbering.yml
2020
TERMS_YML=_data/terms.yml
21-
ALL_OUT=${BIB_MD} ${NUM_YML} ${TERMS_YML}
21+
ALL_OUT=${BIB_MD} ${INDEX_YML} ${NUM_YML} ${TERMS_YML}
2222
EXTRA_MARKDOWN=_includes/intro.md
2323

2424
RELEASE_FILES=\

_config.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -130,6 +130,7 @@ kramdown:
130130
"block-party": ["https://www.blockpartyapp.com/", "Block Party"],
131131
"brown-neil": ["https://twistedsquare.com/", "Neil C. C. Brown"],
132132
"bst-repo": ["https://github.com/gvwilson/buildtogether.tech/", "Building Software Together repository"],
133+
"burns-privacy-quote": ["https://webdevlaw.uk/2021/03/21/privacy-curriculum-developers/", "Heather Burns on privacy"],
133134
"buzzfeed-datacamp": ["http://third-bit.com/2019/04/22/datacamp-clarifications/", "DataCamp Clarifications"],
134135
"captain-awkward": ["https://www.buzzfeednews.com/article/daveyalba/datacamp-sexual-harassment-metoo-tech-startup ", "Buzzfeed article on DataCamp"],
135136
"carnac": ["http://code52.org/carnac/", "Carnac"],

_data/bibliography.yml

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2045,6 +2045,18 @@
20452045
year: 2016
20462046
doi: 10.1146/annurev-psych-010416-044022
20472047

2048+
- key: Meyvis2021
2049+
kind: article
2050+
author:
2051+
- Tom Meyvis
2052+
- Heeyoung Yoon
2053+
year: 2021
2054+
journal: Nature
2055+
volume: 592
2056+
number: 7853
2057+
doi: 10.1038/d41586-021-00592-0
2058+
title: "Adding is Favoured Over Subtracting in Problem Solving"
2059+
20482060
- key: Michaelson2004
20492061
kind: book
20502062
editor:
@@ -2492,6 +2504,13 @@
24922504
year: 2005
24932505
url: https://igda.org/resources-archive/why-crunch-mode-doesnt-work-six-lessons-2005/
24942506

2507+
- key: Robinson2021
2508+
kind: link
2509+
author:
2510+
- Nathan J. Robinson
2511+
title: "Surely We Can Do Better Than Elon Musk"
2512+
url: https://www.currentaffairs.org/2021/04/surely-we-can-do-better-than-elon-musk/
2513+
24952514
- key: Rohrer2015
24962515
kind: article
24972516
author:

_data/index.yml

Lines changed: 23 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -234,6 +234,10 @@
234234
- slug: delivery
235235
title: Wrapping Up
236236
term: build number
237+
- links:
238+
- slug: security
239+
title: Security
240+
term: Burns, Heather
237241
- links:
238242
- slug: tooling
239243
title: Tooling
@@ -494,10 +498,6 @@
494498
- slug: tooling
495499
title: Tooling
496500
term: console
497-
- links:
498-
- slug: automation
499-
title: Automation
500-
term: continous integration - Travis CI
501501
- links:
502502
- slug: automation
503503
title: Automation
@@ -508,6 +508,10 @@
508508
- slug: automation
509509
title: Automation
510510
term: continuous integration - GitHub Actions
511+
- links:
512+
- slug: automation
513+
title: Automation
514+
term: continuous integration - Travis CI
511515
- links:
512516
- slug: teams
513517
title: Teams
@@ -863,7 +867,7 @@
863867
- links:
864868
- slug: errors
865869
title: Error Handling
866-
term: error message - internatioalizing
870+
term: error message - internationalizing
867871
- links:
868872
- slug: errors
869873
title: Error Handling
@@ -1001,7 +1005,7 @@
10011005
- links:
10021006
- slug: research
10031007
title: Research
1004-
term: flow graph - abstract inerpretation
1008+
term: flow graph - abstract interpretation
10051009
- links:
10061010
- slug: research
10071011
title: Research
@@ -1035,7 +1039,7 @@
10351039
- links:
10361040
- slug: security
10371041
title: Security
1038-
term: General Data Protection Regularion (GDPR)
1042+
term: General Data Protection Regulation (GDPR)
10391043
- links:
10401044
- slug: tooling
10411045
title: Tooling
@@ -1291,7 +1295,7 @@
12911295
- links:
12921296
- slug: communicate
12931297
title: Communicating
1294-
term: instant messagin - inevitable use of
1298+
term: instant messaging - inevitable use of
12951299
- links:
12961300
- slug: ip
12971301
title: Intellectual Property
@@ -2499,7 +2503,13 @@
24992503
- links:
25002504
- slug: security
25012505
title: Security
2502-
term: Tech Solidatiry
2506+
term: Tech Solidarity
2507+
- links:
2508+
- slug: communicate
2509+
title: Communicating
2510+
- slug: automation
2511+
title: Automation
2512+
term: technical debt
25032513
- links:
25042514
- slug: contributing
25052515
title: Contributing
@@ -2808,6 +2818,10 @@
28082818
- slug: delivery
28092819
title: Wrapping Up
28102820
term: version numbers
2821+
- links:
2822+
- slug: delivery
2823+
title: Wrapping Up
2824+
term: version numbers - build
28112825
- links:
28122826
- slug: delivery
28132827
title: Wrapping Up
@@ -2824,10 +2838,6 @@
28242838
- slug: delivery
28252839
title: Wrapping Up
28262840
term: version numbers - semantic versioning
2827-
- links:
2828-
- slug: delivery
2829-
title: Wrapping Up
2830-
term: vesion numbers - build
28312841
- links:
28322842
- slug: git-solo
28332843
title: Using Git On Your Own

automation/index.md

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
---
22
---
33

4-
<span class="fixme">Manage dependencies early</span>
5-
64
Everyone is talking about <span g="devops" i="DevOps">DevOps</span> these days,
75
even though (or perhaps because) no one can quite agree what it is. The term
86
mostly seems to refer to practices that minimize the time between a developer
@@ -53,8 +51,8 @@ forehead.
5351

5452
I could live with ugly syntax---if Ie kan lurn Inglish speling, Ie kan lurn
5553
eneething. But the lack of a debugger is a never-ending headache, because real
56-
build systems aren't just configured: they're programmed. Take this book, for
57-
example: its Makefile checks the consistency of cross-references and glossary
54+
build systems aren't just configured: they're programmed. For example, this
55+
book's Makefile checks the consistency of cross-references and glossary
5856
entries, makes sure all the bibliography citations are in place, and copies
5957
files to my web site, and is more complex than many programs I've written.
6058
Thinking of it as a "configuration" file is a mistake: you *have* to <span
@@ -113,6 +111,15 @@ Pick something that plays nicely with your other tools.
113111
<span i="build manager!Ant; Ant; Java!build manager">[Ant][ant]</span>,
114112
which means they can jump directly to compilation errors when they occur.
115113

114+
Be very cautious about adding dependencies.
115+
: "Reduce, re-use, recycle" is as important for software as it is for daily
116+
life, but every library you depend on is one more way for your project to
117+
accumulate <span i="technical debt">technical debt</span>. Recent
118+
research shows that we are all biased toward solving problems by adding
119+
things instead of taking them away <cite>Meyvis2021</cite>; checking the
120+
packages your project depends on before every release and cutting any you
121+
can will prevent a lot of future headaches.
122+
116123
Always use the build manager---never compile or copy things by hand.
117124
: This isn't just for efficiency's sake: if any of the things you need to do
118125
to get your application up on your web site have to be done by hand, the
@@ -178,7 +185,7 @@ definitions in code helps programmers understand software as well.
178185

179186
Build tools will do a lot more for you if you adopt some kind of <span g="ci"
180187
i="continuous integration">continuous integration</span> system such as <span
181-
i="Travis CI; continous integration!Travis CI">[Travis CI][travis-ci]</span> or
188+
i="Travis CI; continuous integration!Travis CI">[Travis CI][travis-ci]</span> or
182189
<span i="GitHub Actions; continuous integration!GitHub Actions">[GitHub
183190
Actions][github-actions]</span>. These can be set up to run either at regular
184191
intervals (e.g., every hour or at three a.m.), or every time someone checks into

bibliography/index.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1078,6 +1078,12 @@ Janet Metcalfe:
10781078
"Learning from Errors".
10791079
<em>Annual Review of Psychology</em>, 68(1), 2016, <a class="doi" href="https://doi.org/10.1146/annurev-psych-010416-044022">10.1146/annurev-psych-010416-044022</a>.
10801080
</dd>
1081+
<dt id="meyvis2021" class="bibliography">Meyvis2021</dt>
1082+
<dd>
1083+
Tom Meyvis and Heeyoung Yoon:
1084+
"Adding is Favoured Over Subtracting in Problem Solving".
1085+
<em>Nature</em>, 592(7853), 2021, <a class="doi" href="https://doi.org/10.1038/d41586-021-00592-0">10.1038/d41586-021-00592-0</a>.
1086+
</dd>
10811087
<dt id="michaelson2004" class="bibliography">Michaelson2004</dt>
10821088
<dd>
10831089
Larry K. Michaelson, Arletta Bauman Knight, and L. Dee Fink (eds.):
@@ -1336,6 +1342,11 @@ New Society Publishers, 2010, 978-0865716513.
13361342
Evan Robinson:
13371343
"<a href="https://igda.org/resources-archive/why-crunch-mode-doesnt-work-six-lessons-2005/">Why Crunch Mode Doesn't Work: 6 Lessons</a>".
13381344
</dd>
1345+
<dt id="robinson2021" class="bibliography">Robinson2021</dt>
1346+
<dd>
1347+
Nathan J. Robinson:
1348+
"<a href="https://www.currentaffairs.org/2021/04/surely-we-can-do-better-than-elon-musk/">Surely We Can Do Better Than Elon Musk</a>".
1349+
</dd>
13391350
<dt id="rohrer2015" class="bibliography">Rohrer2015</dt>
13401351
<dd>
13411352
Doug Rohrer, Robert F. Dedrick, and Sandra Stershic:

communicate/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -202,7 +202,7 @@ archives of stream-of-consciousness exchanges is harder than finding things in
202202
asynchronous media.
203203

204204
But who am I kidding? You're going to use <span i="communication!instant
205-
messaging; instant messagin!inevitable use of">instant messaging</span> no
205+
messaging; instant messaging!inevitable use of">instant messaging</span> no
206206
matter what I say. If more than two people are in the conversation, follow the
207207
same rules you would for a short meeting: post a summary of any decisions you
208208
made where everyone can see it.
@@ -301,7 +301,7 @@ know][evans-manager], all of which apply to student teams:
301301

302302
1. Exactly what individual people on the team are working on.
303303

304-
1. Where the <span g="technical_debt">technical debt</span> is.
304+
1. Where the <span g="technical_debt" i="technical debt">technical debt</span> is.
305305

306306
1. How to help you get better at your job.
307307

delivery/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ to customers, along with instructions about where to put it, rather than
107107
creating a new installer. You should still give it a number, though, and make an
108108
entry in your release log.
109109

110-
The <span g="build_number" i="build number; vesion numbers!build">build
110+
The <span g="build_number" i="build number; version numbers!build">build
111111
number</span> is incremented every time you create a new version of the product
112112
for QA to test. Build numbers are never reset, i.e. you don't go from 5.2.2.1001
113113
to 6.0.0.0, but from 5.2.2.1001 to 6.0.0.1002, and so on. Build numbers are what

errors/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -249,7 +249,7 @@ if fname[-4:] != '.csv':
249249

250250
{: .continue}
251251
A better approach is to put all the error messages in a <span i="error
252-
message!internatioalizing">dictionary</span>:
252+
message!internationalizing">dictionary</span>:
253253

254254
```py
255255
ERRORS = {

research/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -193,7 +193,7 @@ If engineering is applied science, then <cite>Eichberg2015</cite> is a great
193193
example of software engineering. In it, the authors show that it's possible to
194194
identify a wide range of problems in code by comparing the actual <span i="flow
195195
graph!actual">flow graph</span> (which is the set of all possible paths through
196-
the program) with the <span i="flow graph!abstract inerpretation">abstract
196+
the program) with the <span i="flow graph!abstract interpretation">abstract
197197
interpretation flow graph</span> (which is the set of all paths once possible
198198
data values are taken into account). To make this more concrete, the control
199199
flow graph for:

0 commit comments

Comments
 (0)