Inch: How Elixir 1.7 changed the rules for documentation analysis
summary
Inch analyzes Elixir inline docs by fetching unified doc tuples via code.fetch_docs (replacing the deprecated get_docs), reads language, content type, localized strings and metadata from EEP 48, and scores each module/function with role-based rules. It prioritizes items with a numeric priority and surfaces actionable targets using grades instead of percentages (A/B/C/U) and arrowed priorities. A CLI plus the web service Inch CI and badge exist, Inch 2.0 is rewritten in Elixir, and the tool already helps hundreds of Elixir projects.
AI-written summary · about
chapters (6)
related talks
19mIdyll: A Markup Language for Authoring and Publishing Interactive Articles on the Web
30mThe State of Community Documentation
46mAsciidoctor: because writing docs does not have to suck
31mDoc Health Metrics: How Two Writers Built a Framework to Prioritize Docs
29mAsciidoctor: New, Noteworthy, and Beyond
16mInteract with Your Technical Documentation via Generative AI
20mDo Docs Better: Practical Tips on Delivering...
25mGraphQL Docs: Beyond the Schema