Add comment about options for pdf

jnunemaker · jnunemaker · commit 39cac51c4c70 · 2014-11-25T12:50:58.000-05:00
diff --git a/lib/grim/pdf.rb b/lib/grim/pdf.rb
@@ -9,6 +9,10 @@ class Pdf
     # variables if pdf is found.
     #
     # path - A String or Path to the pdf
+    # options - A Hash of options.
+    #           :pdftotext_path - The String path of where to find the pdftotext
+    #                             binary to use when extracting text
+    #                             (default: "pdftotext").
     #
     def initialize(path, options = {})
       raise Grim::PdfNotFound unless File.exists?(path)

Original file line number	Diff line number	Diff line change
`@@ -9,6 +9,10 @@ class Pdf`
`9`	`9`	`# variables if pdf is found.`
`10`	`10`	`#`
`11`	`11`	`# path - A String or Path to the pdf`
	`12`	`+ # options - A Hash of options.`
	`13`	`+ # :pdftotext_path - The String path of where to find the pdftotext`
	`14`	`+ # binary to use when extracting text`
	`15`	`+ # (default: "pdftotext").`
`12`	`16`	`#`
`13`	`17`	`def initialize(path, options = {})`
`14`	`18`	`raise Grim::PdfNotFound unless File.exists?(path)`