Skip to Content
Programming Elixir
book

Programming Elixir

by Dave Thomas
October 2014
Intermediate to advanced
280 pages
7h 20m
English
Pragmatic Bookshelf
Content preview from Programming Elixir

Task: Test the Comments

When I document my functions, I like to include examples of the function being used—comments saying things such as, “Feed it these arguments, and you’ll get this result.” In the Elixir world, a common way to do this is to show the function being used in an iex session.

Here’s an example. Our TableFormatter holds a number of self-contained functions that we can document.

project/5/issues/lib/issues/table_formatter.ex
 
defmodule​ Issues.TableFormatter ​do
 
 
import​ Enum, only: [ each: 2, map: 2, map_join: 3, max: 1 ]
 
 
@doc​ ​"""
 
Takes a list of row data, where each row is a HashDict, and a list of
 
headers. Prints a table to STDOUT of the data from each row
 
identified by each header. That is, each header ...
Become an O’Reilly member and get unlimited access to this title plus top books and audiobooks from O’Reilly and nearly 200 top publishers, thousands of courses curated by job role, 150+ live events each month,
and much more.

Read now

Unlock full access

More than 5,000 organizations count on O’Reilly

AirBnbBlueOriginElectronic ArtsHomeDepotNasdaqRakutenTata Consultancy Services

QuotationMarkO’Reilly covers everything we've got, with content to help us build a world-class technology community, upgrade the capabilities and competencies of our teams, and improve overall team performance as well as their engagement.
Julian F.
Head of Cybersecurity
QuotationMarkI wanted to learn C and C++, but it didn't click for me until I picked up an O'Reilly book. When I went on the O’Reilly platform, I was astonished to find all the books there, plus live events and sandboxes so you could play around with the technology.
Addison B.
Field Engineer
QuotationMarkI’ve been on the O’Reilly platform for more than eight years. I use a couple of learning platforms, but I'm on O'Reilly more than anybody else. When you're there, you start learning. I'm never disappointed.
Amir M.
Data Platform Tech Lead
QuotationMarkI'm always learning. So when I got on to O'Reilly, I was like a kid in a candy store. There are playlists. There are answers. There's on-demand training. It's worth its weight in gold, in terms of what it allows me to do.
Mark W.
Embedded Software Engineer

You might also like

Programming Ecto

Programming Ecto

Darin Wilson, Eric Meadows-Jonsson
Testing Elixir

Testing Elixir

Andrea Leopardi, Jeffrey Matthias

Publisher Resources

ISBN: 9781680500530Errata Page