Skip to content

Commit

Permalink
Mildly better class comments.
Browse files Browse the repository at this point in the history
  • Loading branch information
Frank Shearar committed Feb 19, 2013
1 parent 98bc5c4 commit 223ac6b
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions lib/zipr/zipper.rb
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ module Zipr
# A zipper is a data structure consisting of a value (representing some place
# in some data structure) and a context (the rest of the structure, or the
# hole into which you plug the value to have the original structure once more).
# This context also contains the route by which you ended up at this place in
# the structure.
#
# You may think of a zipper as a suspended walk - that is, as a means of
# navigating and mutating a data structure such that at any point you can store
Expand All @@ -22,8 +24,8 @@ module Zipr
# a Left if the action is impossible (for instance, trying to move down on a
# leaf node of a tree). An unsafe operation simply raises a
# ZipperNavigationError in the event of an impossible action. Unsafe operations
# provide a terser navigation, at the risk of raising an exception. A chain of
# safe operations simply returns the first error encountered.
# provide a more terse navigation, at the risk of raising an exception. A chain
# of safe operations simply returns the first error encountered.
class Zipper
include Boing

Expand Down

0 comments on commit 223ac6b

Please sign in to comment.