Clarify that LocalStorage needs to be required

adambeynon · adambeynon · commit 58ab3e4b841d · 2014-12-06T21:15:58.000Z
diff --git a/opal/opal-jquery/local_storage.rb b/opal/opal-jquery/local_storage.rb
@@ -8,6 +8,17 @@ module Browser
   #
   # ## Usage
   #
+  # LocalStorage is not included by default when you require opal-jquery, so
+  # you will need to require it explicitly in your code:
+  #
+  #     require 'opal-jquery'
+  #     require 'opal-jquery/local_storage'
+  #
+  #     puts LocalStorage
+  #     # => #<LocalStorage>
+  #
+  # ## Example Usage
+  #
   #     LocalStorage['foo'] = 'hello world'
   #
   #     LocalStorage['foo'] # => "hello world"

Original file line number	Diff line number	Diff line change
`@@ -8,6 +8,17 @@ module Browser`
`8`	`8`	`#`
`9`	`9`	`# ## Usage`
`10`	`10`	`#`
	`11`	`+ # LocalStorage is not included by default when you require opal-jquery, so`
	`12`	`+ # you will need to require it explicitly in your code:`
	`13`	`+ #`
	`14`	`+ # require 'opal-jquery'`
	`15`	`+ # require 'opal-jquery/local_storage'`
	`16`	`+ #`
	`17`	`+ # puts LocalStorage`
	`18`	`+ # # => #<LocalStorage>`
	`19`	`+ #`
	`20`	`+ # ## Example Usage`
	`21`	`+ #`
`11`	`22`	`# LocalStorage['foo'] = 'hello world'`
`12`	`23`	`#`
`13`	`24`	`# LocalStorage['foo'] # => "hello world"`