Skip to content
DevMeme
4695 of 7590
Documentation Post #5145 · source on Telegram

Rust and Haskell suggest books and papers instead of simple library docs

Description

Cartoon-style meme on a pale green background. Top caption in large capitals reads: "I JUST WROTE A LIBRARY, SHOULD I WRITE SOME DOCS?" A developer seen from behind (green hoodie, laptop under arm labeled "HARDER BUGS") poses the question. Two other characters face her: the middle one wears an orange shirt with the gear-shaped Rust logo and replies in smaller text above, "NO, JUST WRITE A BOOK"; the rightmost wears a purple shirt with the Haskell lambda-arrow logo, holding a coffee cup, and says "NO, JUST WRITE A PAPER." The humor riffs on how certain language communities (Rust’s extensive book-level guides and Haskell’s academic papers) sometimes prefer heavyweight literature over straightforward API documentation, poking fun at documentation culture and language tribalism familiar to seasoned engineers

Comments

9
Anonymous ★ Top Pick Rust and Haskell don’t skip docs; they just embed the API in a 400-page book or a peer-reviewed PDF so that by the time you find the function signature, you’ve earned the lifetime
  1. Anonymous ★ Top Pick

    Rust and Haskell don’t skip docs; they just embed the API in a 400-page book or a peer-reviewed PDF so that by the time you find the function signature, you’ve earned the lifetime

  2. Anonymous

    The eternal documentation dilemma: Rust devs will write you a 500-page book explaining ownership semantics before adding a single README example, while Haskell devs publish category theory papers that require a PhD to understand why your monad transformer stack won't compile. Meanwhile, your users just want to know what parameters your function takes

  3. Anonymous

    Ah yes, the classic open-source maintainer's guide to documentation: Step 1 - Write a brilliant library. Step 2 - Publish a 400-page O'Reilly book and three peer-reviewed papers. Step 3 - Wonder why adoption is slow when your README just says 'see the book.' Meanwhile, developers are desperately grepping through your test suite trying to figure out how to instantiate your main class. It's the academic equivalent of 'the code is self-documenting' - technically impressive, commercially impractical, and guaranteed to spawn a dozen 'Awesome X' lists trying to reverse-engineer your API from conference talks

  4. Anonymous

    Docs? Nah, drop a 400-page tome or arXiv paper - users make great peer reviewers

  5. Anonymous

    Library release checklist: docs if it’s sane, a book if your API leaks lifetimes, and a paper if the type signature is the proof

  6. Anonymous

    Rust points you to Chapter 8; Haskell hands you a DOI - somewhere between rustdoc and Haddock, your onboarding estimate just slipped from hours to quarters

  7. @ZgGPuo8dZef58K6hxxGVj3Z2 3y

    Lmao

  8. @misesOnWheels 3y

    javascript: no, just write an endlessly scrolling webpage

    1. @LeslieFn 3y

      no, just write undefined

Use J and K for navigation