Skip to content
This repository
Browse code

Updated processor documentation

  • Loading branch information...
commit 0358216871ad2660080edeb87e8f65161b7cd11c 1 parent 65fb926
Jon Yurek authored May 11, 2009

Showing 1 changed file with 7 additions and 6 deletions. Show diff stats Hide diff stats

  1. 13  lib/paperclip/processor.rb
13  lib/paperclip/processor.rb
@@ -5,13 +5,14 @@ module Paperclip
5 5
   # are not required to follow suit.
6 6
   #
7 7
   # Processors are required to be defined inside the Paperclip module and
8  
-  # are also required to be a subclass of Paperclip::Processor. There are
9  
-  # only two methods you must implement to properly be a subclass: 
10  
-  # #initialize and #make. Initialize's arguments are the file that will
11  
-  # be operated on (which is an instance of File), and a hash of options
12  
-  # that were defined in has_attached_file's style hash.
  8
+  # are also required to be a subclass of Paperclip::Processor. There is
  9
+  # only one method you *must* implement to properly be a subclass: 
  10
+  # #make, but #initialize may also be of use. Both methods accept 3
  11
+  # arguments: the file that will be operated on (which is an instance of
  12
+  # File), a hash of options that were defined in has_attached_file's
  13
+  # style hash, and the Paperclip::Attachment itself.
13 14
   #
14  
-  # All #make needs to do is return an instance of File (Tempfile is
  15
+  # All #make needs to return is an instance of File (Tempfile is
15 16
   # acceptable) which contains the results of the processing.
16 17
   #
17 18
   # See Paperclip.run for more information about using command-line

0 notes on commit 0358216

Please sign in to comment.
Something went wrong with that request. Please try again.