Permalink
Browse files

small docs tweaks

  • Loading branch information...
1 parent b47a4f2 commit 7a90a51e9f055a7544fc3001cbe233415f8b4f7e @clux committed Mar 16, 2012
Showing with 7 additions and 7 deletions.
  1. +3 −3 docs/api.html
  2. +1 −1 docs/npm.html
  3. +3 −3 docs/tinyapi.html
View
@@ -400,13 +400,13 @@
<p>Both these functions will overwrite on repeat calls. For example:</p>
<pre><code>ns.data('libX', libXobj);
-require('data::libX'); // -&gt; libXobj
+ns.require('data::libX'); // -&gt; libXobj
ns.data('libX', {});
-require('data::libX'); // -&gt; {}
+ns.require('data::libX'); // -&gt; {}
ns.data('libX'); //unsets
-require('data::libX'); // -&gt; undefined
+ns.require('data::libX'); // -&gt; undefined
</code></pre>
<p>And similarly for <code>ns.external</code>.
View
@@ -39,7 +39,7 @@
<p>Everything in the npm folder specified can be required, but it is optimized to obtain modules in the root.
Modules are required like on the server, but you have to specify the npm domain to avoid accidentally pulling in big files when requiring from the main domain.</p>
-<p>E.g. <code>require('npm::backbone')</code> would pull in underscore, but <code>require('underscore')</code> would not necessarily work.</p>
+<p>E.g. <code>require('npm::backbone')</code> would pull in underscore, but <code>require('npm::underscore')</code> would not necessarily work.</p>
<p><code>require('npm::backbone')</code> with backbone installed, would pull its underscore dependency from either backbone/node_modules/underscore, or underscore.
For underscore to also be easily requirable (and to prevent pulling in copies or different versions),
View
@@ -188,10 +188,10 @@
<p>Examples values:</p>
<ul>
-<li><code>jQuery</code></li>
-<li><code>$(document).ready</code></li>
+<li>"jQuery"</li>
+<li>"$(document).ready"</li>
<li>function (code) { return "jQuery(function () {" + code + "})"; }</li>
-<li>`` // blank string - default</li>
+<li>"" // blank string - default</li>
</ul>
<p>The last example simply wraps the app domain code in an anonymous,

0 comments on commit 7a90a51

Please sign in to comment.