~/talk

Read The Functional Manual: But First We Need to Write It

on YouTube 47m
Talkat LambdaConf 2018 · 2018-06-03..06-05· [open-source]

speaker

name:Fintan Halpenny
links:none on file

resources

video:https://youtu.be/G6D8Eoiz5pQ
slides:none on file

summary

Argues that documentation must show concrete decisions: uses Haddock + stack to generate docs beside code, adds inline comments, examples and doc-tests checked at compile time, and wires search via Hackage/Google Haskell and Stackage snapshots. Demonstrates a live pull request that documents a confusing expressionFromText binding and lands successfully. Categorizes docs as types, names, usage, tutorials, cites contributions to esqueleto and proto-lens, and notes a $5 bounty incentive for small documentation PRs.

AI-written summary · about

chapters (7)

  1. 0:00Start
  2. 24:42Code Blocks
  3. 25:30Hyper Linking
  4. 26:24Add Headers
  5. 34:04Documenting via Usage
  6. 35:48Examples
  7. 36:58H Matrix

related talks

~/search
type to search 6,249 conferences, 138,987 speakers and 185,172 talks
~/help
cmdctrl k
search every conference, speaker and series
/
focus the filter search
h
home
c
conferences
s
speakers
e
series
t
light / dark — the status bar button does the same
?
this help
esc
close this, then clear every filter — or just the search, while you are typing in it

Ignored while you are typing. Pages without a filter rail have no search to focus.