Skip to content

Instantly share code, notes, and snippets.

View nwhitehead's full-sized avatar

Nathan Whitehead nwhitehead

View GitHub Profile
# Conformance suites: what they are, when they help, how to build one
A conformance suite is a third axis of testing — distinct from unit tests
and integration tests. Where unit tests prove that a function does what
its body says, and integration tests prove that subsystems compose, a
conformance suite proves that **what the public API claims it does
matches what it actually does, against an external ground truth**.
This document explains the pattern, when it earns its keep, and how to
set one up. The case study is ferrotorch (a pure-Rust PyTorch
name xkcd-2501
description Audit a piece of writing for expert blind spots — terms, concepts, or context that the writer has unconsciously treated as common knowledge, but which the target audience may not share. Based on xkcd 2501 "Average Familiarity": even when experts consciously try to simplify for a general audience, they still massively overestimate what readers know. Use this skill whenever the user wants to check if their writing is accessible to a specific audience, asks "will people follow this?", wants a jargon or assumed-knowledge review, or supplies a draft and a target reader. Also trigger when the user says "I tried to make it accessible but I'm not sure", or pastes something technical and wants to know what a non-expert reader would stumble on.

xkcd 2501: Average Familiarity Audit

The Problem This Skill Solves

@signaldust
signaldust / halite.cpp
Created January 15, 2022 17:11
Halite - an analog circuit simulator in ~1k lines of code
#include <vector>
#include <string>
#include <cstdio>
#include <cmath>
// set to 1 to make LU factorization show pivots
#define VERBOSE_LU 0
// gMin for diodes etc..
static const double gMin = 1e-12;