lib/quke/configuration.rb in quke-0.5.0 vs lib/quke/configuration.rb in quke-0.6.0

@@ -150,9 +150,21 @@
     # to the different drivers when registering them with Capybara.
     def use_proxy?
       proxy['host'] != ''
     end
 
+    # Return the hash of +custom+ server settings
+    #
+    # This returns a hash of all the key/values in the custom section of your
+    # +.config.yml+ file. You can then access it in your steps/page objects with
+    #
+    #     Quke::Quke.config.custom["default_org_name"] # = "Testy Ltd"
+    #     Quke::Quke.config.custom["accounts"]["account2"]["username"] # = "[e-mail]"
+    #     Quke::Quke.config.custom["urls"]["front_office"] # = "http://myservice.service.gov.uk"
+    #
+    # As long as what you add is valid YAML (check with a tool like
+    # http://www.yamllint.com/) Quke will be able to pick it up and make it
+    # available in your tests.
     def custom
       @data['custom']
     end
 
     private