$osf, not $.osf

CenterForOpenScience · Feb 5, 2015 · 52ef7bd · 52ef7bd
1 parent 660319a
commit 52ef7bd
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 5 deletions.
diff --git a/docs/osf/guidelines.rst b/docs/osf/guidelines.rst
@@ -186,7 +186,7 @@ All client-side HTTP requests should have proper error handlers. As an example,
 .. code-block:: javascript
 
     var url = '/api/v1/profile';
-    var request = $.osf.putJSON(url, {'email': 'foo@bar.com'});
+    var request = $osf.putJSON(url, {'email': 'foo@bar.com'});
 
     request.done(function(response) { ... });
 
@@ -202,12 +202,13 @@ All client-side HTTP requests should have proper error handlers. As an example,
         });
     });
 
-When appropriate, you can use the generic `$.osf.handleJSONError`, which will display a generic error message in a modal to the user if a failure occurs.
+When appropriate, you can use the generic `$osf.handleJSONError`, which will display a generic error message in a modal to the user if a failure occurs.
 
 .. code-block:: javascript
 
+    var $osf = require('osfHelpers');
     // ...
-    request.fail($.osf.handleJSONError);
+    request.fail($osf.handleJSONError);
 
 Documentation
 *************

diff --git a/docs/style_guides/javascript.rst b/docs/style_guides/javascript.rst
@@ -64,9 +64,9 @@ Follow `Abhinay Rathore's jQuery Coding Standards Guide <http://lab.abhinayratho
 AJAX
 ----
 
-For PUTting and POSTing to JSON endpoints in the OSF, use the ``$.osf.postJSON`` and ``$.osf.putJSON`` functions (located in ``site.js``). This will handle JSON stringification as well as set the correct dataType and contentType.
+For PUTting and POSTing to JSON endpoints in the OSF, use the ``$osf.postJSON`` and ``$osf.putJSON`` functions (located in ``osfHelpers.js``). This will handle JSON stringification as well as set the correct dataType and contentType.
 
-When using ``$.osf.postJSON``, ``$.osf.putJSON``, or ``jQuery.ajax``, use the Promises interface.
+When using ``$osf.postJSON``, ``$osf.putJSON``, or ``jQuery.ajax``, use the Promises interface.
 
 .. code-block:: javascript