format_array 1.1 → 1.2

data/CHANGELOG

@@ -1,3 +1,5 @@
+v1.2. Add some (thin) documentation
+
 v1.1. Add some trivial tests and parameterise our length
 
 v1.0. First cut

data/format_array.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{format_array}
-  s.version = "1.1"
+  s.version = "1.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = [""]

data/lib/format_array.rb

@@ -1,6 +1,15 @@
-CUTOFF=120
+# = format_array.rb
+#
+# == Example
+# 
+#  require 'format_array'
+#  # default cutoff is 120 characters
+#  format_array(['list','of','things'], 'PREFIX')
+# 
+#  # we can specify our own, say 76
+#  format_array(['list','of','things'], 'PREFIX', 76)
 
-def format_array(a, p, cutoff=CUTOFF, j='; ')
+def format_array(a, p, cutoff=120, j='; ')
     raw = a.sort.join(j)
     tmp = "#{p}: #{raw}"
 
@@ -12,7 +21,7 @@ def format_array(a, p, cutoff=CUTOFF, j='; ')
     # try a naive longest->shortest distribution
     lines = raw.length / cutoff
     sa = a.sort_by {|s| s.length}.reverse
-    out = Array.new(12) { Array.new }
+    out = Array.new(12) { Array.new } # what does magic 12 mean?
     while (sa.length > lines+1) do
         0.upto(lines) { |i|
             out[i].push sa.shift

metadata

@@ -1,12 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: format_array
 version: !ruby/object:Gem::Version 
-  hash: 13
+  hash: 11
   prerelease: false
   segments: 
   - 1
-  - 1
-  version: "1.1"
+  - 2
+  version: "1.2"
 platform: ruby
 authors: 
 - ""