Add comment about options for page

jnunemaker · jnunemaker · commit 17a08a472bf6 · 2014-11-25T12:50:09.000-05:00
diff --git a/lib/grim/page.rb b/lib/grim/page.rb
@@ -8,6 +8,10 @@ class Page
     #
     # pdf - the pdf this page belongs to
     # index - the index of the page in the array of pages
+    # 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(pdf, index, options = {})
       @pdf    = pdf

Original file line number	Diff line number	Diff line change
`@@ -8,6 +8,10 @@ class Page`
`8`	`8`	`#`
`9`	`9`	`# pdf - the pdf this page belongs to`
`10`	`10`	`# index - the index of the page in the array of pages`
	`11`	`+ # options - A Hash of options.`
	`12`	`+ # :pdftotext_path - The String path of where to find the pdftotext`
	`13`	`+ # binary to use when extracting text`
	`14`	`+ # (default: "pdftotext").`
`11`	`15`	`#`
`12`	`16`	`def initialize(pdf, index, options = {})`
`13`	`17`	`@pdf = pdf`