Skip to content
This repository
Browse code

Some tweaks to dandv's doc cleanups.

  • Loading branch information...
commit 7d8f744f157871e5849deeffb3651334b771762e 1 parent 5ccacd1
David Glasser authored
51  docs/client/api.html
@@ -340,32 +340,31 @@ <h2 id="connections"><span>Server connections</span></h2>
340 340
 the server. The return value is an object with the following fields:
341 341
 
342 342
 <dl class="objdesc">
343  
-<dt><span class="name">connected</span>
344  
-  <span class="type">Boolean</span></dt>
345  
-<dd>True if currently connected to the server. If false, changes and
  343
+{{#dtdd name="connected" type="Boolean"}}
  344
+  True if currently connected to the server. If false, changes and
346 345
   method invocations will be queued up until the connection is
347  
-  reestablished.</dd>
  346
+  reestablished.
  347
+{{/dtdd}}
348 348
 
349  
-<dt><span class="name">status</span>
350  
-  <span class="type">String</span></dt>
351  
-<dd>Describes the current reconnection status. The possible
352  
-  values are <code>connected</code> (the connection is up and
353  
-  running), <code>connecting</code> (disconnected and trying to open a
354  
-  new connection), and <code>waiting</code> (failed to connect and
355  
-  waiting to try to reconnect).</dd>
  349
+{{#dtdd name="status" type="String"}}
  350
+  Describes the current reconnection status. The possible
  351
+  values are `connected` (the connection is up and
  352
+  running), `connecting` (disconnected and trying to open a
  353
+  new connection), and `waiting` (failed to connect and
  354
+  waiting to try to reconnect).
  355
+{{/dtdd}}
356 356
 
357  
-<dt><span class="name">retryCount</span>
358  
-  <span class="type">Number</span></dt>
359  
-<dd>The number of times the client has tried to reconnect since the
360  
-  connection was lost. 0 when connected.</dd>
  357
+{{#dtdd name="retryCount" type="Number"}}
  358
+  The number of times the client has tried to reconnect since the
  359
+  connection was lost. 0 when connected.
  360
+{{/dtdd}}
361 361
 
362  
-<dt><span class="name">retryTime</span>
363  
-  <span class="type">Number or undefined</span></dt>
364  
-<dd>The estimated time of the next reconnection attempt. To turn this
  362
+{{#dtdd name="retryTime" type="Number or undefined"}}
  363
+  The estimated time of the next reconnection attempt. To turn this
365 364
   into an interval until the next reconnection, use
366  
-  <code>retryTime - (new Date()).getTime()</code>. This key will
367  
-  be set only when <code>status</code> is <code>waiting</code>.
368  
-</dd>
  365
+  `retryTime - (new Date()).getTime()`. This key will
  366
+  be set only when `status` is `waiting`.
  367
+{{/dtdd}}
369 368
 </dl>
370 369
 
371 370
 Instead of using callbacks to notify you on changes, this is
@@ -786,7 +785,7 @@ <h2 id="collections"><span>Collections</span></h2>
786 785
 collection. This is the only effect of insecure mode. If you call `allow` or
787 786
 `deny` at all on a collection, even `Posts.allow({})`, then access is checked
788 787
 just like normal on that collection. __New Meteor projects start in insecure
789  
-mode by default.__ To turn it off just run `meteor remove insecure`.
  788
+mode by default.__ To turn it off just run `$ meteor remove insecure`.
790 789
 
791 790
 {{#note}}
792 791
 For `update` and `remove`, documents will be affected only if they match
@@ -1317,7 +1316,7 @@ <h2 id="accounts_api"><span>Accounts</span></h2>
1317 1316
 
1318 1317
 
1319 1318
 Each external service has its own login provider package and login function. For
1320  
-example, to support GitHub login, run `meteor add accounts-github` and use the
  1319
+example, to support GitHub login, run `$ meteor add accounts-github` and use the
1321 1320
 `Meteor.loginWithGithub` function:
1322 1321
 
1323 1322
     Meteor.loginWithGithub({
@@ -1422,7 +1421,7 @@ <h2 id="accounts_passwords"><span>Passwords</span></h2>
1422 1421
 helps protect against embarrassing password leaks if the server's
1423 1422
 database is compromised.
1424 1423
 
1425  
-To add password support to your application, run `meteor add
  1424
+To add password support to your application, run `$ meteor add
1426 1425
 accounts-password`. You can construct your own user interface using the
1427 1426
 functions below, or use the [`accounts-ui` package](#accountsui) to
1428 1427
 include a turn-key user interface for password-based sign-in.
@@ -2340,7 +2339,7 @@ <h2 id="meteor_deps"><span>Meteor.deps</span></h2>
2340 2339
 <h2 id="meteor_http"><span>Meteor.http</span></h2>
2341 2340
 
2342 2341
 `Meteor.http` provides an HTTP API on the client and server.  To use
2343  
-these functions, add the HTTP package to your project with `meteor add
  2342
+these functions, add the HTTP package to your project with `$ meteor add
2344 2343
 http`.
2345 2344
 
2346 2345
 {{> api_box httpcall}}
@@ -2440,7 +2439,7 @@ <h2 id="meteor_http"><span>Meteor.http</span></h2>
2440 2439
 <h2 id="email"><span>Email</span></h2>
2441 2440
 
2442 2441
 The `email` package allows sending email from a Meteor app. To use it, add the
2443  
-package to your project with `meteor add email`.
  2442
+package to your project with `$ meteor add email`.
2444 2443
 
2445 2444
 The server reads from the `MAIL_URL` environment variable to determine how to
2446 2445
 send mail. Currently, Meteor supports sending mail over SMTP; the `MAIL_URL`
2  docs/client/api.js
@@ -149,7 +149,7 @@ Template.api.subscription_userId = {
149 149
   id: "publish_userId",
150 150
   name: "<i>this</i>.userId",
151 151
   locus: "Server",
152  
-  descr: ["Property of the publish handler object. The id of the logged-in user, or `null` if no user is logged in."]
  152
+  descr: ["Access inside the publish function. The id of the logged-in user, or `null` if no user is logged in."]
153 153
 };
154 154
 
155 155
 
15  docs/client/concepts.html
@@ -43,15 +43,12 @@ <h2 id="structuringyourapp">Structuring your application</h2>
43 43
 You're free to use a single JavaScript file for your entire application, or
44 44
 create a nested tree of separate files, or anything in between.
45 45
 
46  
-Files in a `tests` directory are not loaded anywhere. This is the place
47  
-for unit tests and any files related to [test-driven development](http://stackoverflow.com/questions/12987525/meteor-test-driven-development).
48  
-
49  
-Files outside the `client`, `server` and `tests`
50  
-subdirectories are loaded on both the client and the server!  That's
51  
-the place for model definitions and other functions.  Meteor provides
52  
-the variables [`isClient` and `isServer`](#meteor_isclient) so that
53  
-your code can alter its behavior depending on whether it's running
54  
-on the client or the server.
  46
+Files outside the `client`, `server` and `tests` subdirectories are loaded on
  47
+both the client and the server!  That's the place for model definitions and
  48
+other functions.  Meteor provides the variables [`isClient` and
  49
+`isServer`](#meteor_isclient) so that your code can alter its behavior depending
  50
+on whether it's running on the client or the server. (Files in directories named
  51
+`tests` are not loaded anywhere.)
55 52
 
56 53
 Any sensitive code that you don't want served to the client, such as code
57 54
 containing passwords or authentication mechanisms, should be

0 notes on commit 7d8f744

Please sign in to comment.
Something went wrong with that request. Please try again.