Adds documentation for Resource#slug method

malachheb · Oct 8, 2013 · d967454 · d967454
1 parent df34b5f
commit d967454
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/lib/calamum/resource.rb b/lib/calamum/resource.rb
@@ -20,9 +20,11 @@ def initialize(attrs)
     @tryit = attrs['tryit']
   end
 
+  # Returns a unique, but readable name for this resource suitable for use as a filename
+  #
+  # @return [String] resource filename
   def slug
     sanitized_uri = uri.gsub(/[^\w]/, '_').gsub('__', '_')
-
     "#{sanitized_uri}_#{action.downcase}_#{self.object_id}"
   end