Technical Note Sample

This sample post is a small checklist for technical writing on this site. It demonstrates the pieces that are easiest to forget when drafting: front matter, code, equations, figures, and footnotes.

A Tiny Experiment

Suppose we want to compare a running average against a threshold. The implementation is intentionally small:

def running_mean(values):
    total = 0.0
    for index, value in enumerate(values, start=1):
        total += value
        yield total / index

print(list(running_mean([3, 1, 4, 1, 5])))

Inline math uses \( ... \), so we can write ( \mu_t = \frac{1}{t}\sum_{i=1}^{t}x_i ). Display math uses $$ ... $$:

Figure

Images can live in /images and be referenced directly:

Footnote

Footnotes are useful for side remarks without interrupting the main thread.¹