Upgrade to Pro — share decks privately, control downloads, hide ads and more …

A Documentation Talk

Zach Holman
September 02, 2011

A Documentation Talk

"A Documentation Talk" sounds pretty boring, right? Wouldn't it be scandalously titillating if this talk's title included detailed analysis of the expectations and results of the talk itself? Jeez it's like someone's making an overt metaphor for how Rubyists document their code.

At GitHub, we add docs to every single method we write, and we couldn't be more excited about it. It means faster and simpler code. It means stronger tests. It means your developers can pay attention to new commits without stressing about them. Documentation will make your project so very happy.

Zach Holman

September 02, 2011
Tweet

More Decks by Zach Holman

Other Decks in Programming

Transcript

  1. # Public: This adds a mustache to an image. #

    # image - A String path to a local image on disk. # # Examples # # add_mustache(‘~/Desktop/zach.gif’) # # => ‘/tmp/zach.mustache.gif’ # # Returns the String path to the processed image. def add_mustache(image) end
  2. # Public: This adds a mustache to an image. #

    # image - A String path to a local image on disk. # # Examples # # add_mustache(‘~/Desktop/zach.gif’) # # => ‘/tmp/zach.mustache.gif’ # # Returns the String path to the processed image. def add_mustache(image) end
  3. # Public: This adds a mustache to an image. #

    # image - A String path to a local image on disk. # # Examples # # add_mustache(‘~/Desktop/zach.gif’) # # => ‘/tmp/zach.mustache.gif’ # # Returns the String path to the processed image. def add_mustache(image) end
  4. # Public: This adds a mustache to an image. #

    # image - A String path to a local image on disk. # # Examples # # add_mustache(‘~/Desktop/zach.gif’) # # => ‘/tmp/zach.mustache.gif’ # # Returns the String path to the processed image. def add_mustache(image) end
  5. # Public: This adds a mustache to an image. #

    # image - A String path to a local image on disk. # # Examples # # add_mustache(‘~/Desktop/zach.gif’) # # => ‘/tmp/zach.mustache.gif’ # # Returns the String path to the processed image. def add_mustache(image) end