Commit Graph

279 Commits

Author SHA1 Message Date
David Glasser
df47013639 Fix Accounts.createUser docs
Fixes #1777.
2014-01-29 14:48:38 -08:00
David Glasser
204959b509 Fix pronoun in docs 2014-01-27 16:30:43 -08:00
David Glasser
f53bf0ab82 Docs for wrapTransform 2014-01-27 16:29:59 -08:00
Nathan Le Ray
4cf8b41d5d Fix a typo in the API doc 2014-01-15 14:32:43 -08:00
David Glasser
53de3f21ba Improve docs for server-to-server collections
Fixes #1723.
2014-01-07 17:15:06 -08:00
David Glasser
ce77adc22e Remove warning about update/$ 2014-01-07 17:00:18 -08:00
David Glasser
add4f6e015 Disallow {fields:{_id:0}} in observeChanges
This implies it is not allowed in `observe` either, or in cursors
returned from publish functions, or in cursors used in {{#each}}

Why? observeChanges and DDP publication use the ID as part of the
callback/message, and eliding it completely breaks them. Meteor UI uses
the ID with {{#each}} to properly move nodes around instead of
re-rendering. We could try to allow it for `observe` outside of
{{#each}}, but it would feel somewhat inconsistent.
2014-01-06 21:16:23 -08:00
Matt DeBergalis
412f89a352 document return value of Deps.nonreactive 2013-12-26 22:59:05 -08:00
Dan Dascalescu
b556a474d3 Mention Meteor.bindEnvironment
Google searches for the error fail to find the Meteor docs, and there was no mention of bindEnvironment therein.
2013-12-06 14:12:18 -08:00
David Glasser
51b786c64c docs: Fix line break and punctuation 2013-12-06 13:40:59 -08:00
Denis Gorbachev
5a8fcee957 Fix docs paragraph 2013-12-06 13:39:07 -08:00
Nick Martin
8f05510b59 Make onClose fire immediately instead of never on already closed connection. 2013-12-05 13:14:11 -08:00
Andrew Wilcox
79f845f735 Clarify note on client reconnections. 2013-12-05 13:14:10 -08:00
Andrew Wilcox
e253ecd46a Another session -> connection renaming. 2013-12-05 13:14:10 -08:00
Nick Martin
a3bbb6dfa1 Update and tweak docs for new name. 2013-12-05 13:14:10 -08:00
Andrew Wilcox
62fe9c62e5 Add a "this.session" entry for methods in the docs.
Pull out the session object into its own documentation section.
2013-12-05 13:11:40 -08:00
Andrew Wilcox
c1d97fde7c Also make the session available in publish functions. 2013-12-05 13:11:40 -08:00
Andrew Wilcox
26e9fad096 In the docs, refer to the public object as a "session" instead of a
"session handle".
2013-12-05 13:11:40 -08:00
Andrew Wilcox
819019f08f Mention that session id's are globally unique. 2013-12-05 13:11:40 -08:00
Andrew Wilcox
badb6e9d30 Documentation update.
Document `Meteor.onConnection` instead of `Meteor.server.onConnection`.

Condense sections about when there is a session reconnect into a
single {{note}}.

Document the `stop` handle returned by `onConnect`.

Document `this.session` in Meteor.methods section.
2013-12-05 13:11:39 -08:00
Andrew Wilcox
8644363f1a Meteor.server.onConnection documentation. 2013-12-05 13:11:39 -08:00
Avital Oliver
b242f20ffe Fix docs on http package
The recent change to throw errors wasn't done to completion.
Update the examples and some of the prose.
2013-10-17 16:36:13 -07:00
Emily Stark
7f64c726f7 Merge branch 'mongo-upsert' into devel 2013-10-02 13:23:22 -07:00
Emily Stark
dec262b239 Document upsert (first draft) 2013-10-02 12:17:04 -07:00
Emily Stark
ae6ab2d775 Fix logoutOtherClients docs typos 2013-10-02 11:37:27 -07:00
Emily Stark
f67cf78b2d Add docs for loginExpirationInDays and logoutOtherClients() 2013-10-02 11:37:27 -07:00
Slava Kim
3a8fc57a24 Fix docs typo. 2013-09-30 18:11:47 -07:00
Slava Kim
60dd2c89ff Clarify minimongo fields docs. 2013-09-30 17:59:07 -07:00
David Glasser
7f490a4081 Docs for ES5-style iteration. 2013-09-27 19:00:22 -05:00
Matt DeBergalis
a6db08ce8d Improve the explanation of manual publisher functions.
Fixes #1018.
2013-09-25 23:00:32 -07:00
Slava Kim
eb5d426a7c Fix docs. $slice is not related to fields projection. 2013-09-13 01:51:25 -07:00
Slava Kim
b24066d477 Improve documentation on fields.
- You can mix incl/excl as long as it is `_id`
- Note unsupported `$` and `$slice` operators of minimongo
- Give an advanced example with reference to mongodb docs.
2013-09-13 01:51:24 -07:00
Emily Stark
c4f52b7551 Update docs for Date types on createdAt fields. 2013-08-21 15:19:05 -07:00
Emily Stark
d567bbdaf3 Fix docs typo.
Fixes #1297
2013-08-20 10:52:45 -07:00
David Glasser
3d5c288b2b Remove newline from 'meteor add http'. 2013-08-19 16:24:32 -07:00
Slava Kim
ed9cb03ac1 Merge branch 'minimongo-fields' into devel
Support for 'fields' option in minimongo. Observe on the fields certain fields
will fire 'change' events only if one of watched fields changed.

Note: in minimongo observe, granularity of diff is one level. Meaning, watching
for changes at 'foo.bar' may fire even if 'foo.bar' didn't change.

Fixes #1287.
2013-08-15 14:38:20 -07:00
David Glasser
f5531b41a6 Small doc cleanups:
- Fix order of ')' and '.' in a bunch of places

- Remove last reference to "smart packages"

- Fix an Atmosphere link

- Linkify a bunch of other things (CoffeeScript, npm, GitHub bug tracker, etc)

- Added a newline after the dot in "`meteor`. `meteor`".  It looked way more
  like `meteor.meteor` when rendered.

- Name `api.add_files` explicitly.

- Fix capitalization of GitHub

- Explain how weak deps check if the dep is there

- A few other typos
2013-08-13 09:25:47 -07:00
Nick Martin
2471dcba7e remove 'temporarily' in reference to Meteor.disconnect. It's not really temporary. 2013-08-12 23:40:32 -07:00
Nick Martin
e2344a2a07 Fixup ids for Meteor.http -> HTTP transition. 2013-08-09 17:52:25 -07:00
Slava Kim
dab1d19e61 Docs and typos in minimongo. 2013-08-07 12:54:37 -07:00
Slava Kim
e16738e920 Better docs for Match.Optional. 2013-08-05 16:14:59 -07:00
Slava Kim
580de65f62 Grammar corrections. Comments moving. 2013-08-05 13:26:43 -07:00
Slava Kim
ffc31748f5 Make docs for Match.Optional more truthy about undefined in an object. 2013-08-02 14:25:03 -07:00
Slava Kim
86022fb06e Docs for Match.Integer 2013-08-02 14:25:03 -07:00
David Glasser
a5c061ecde Rename Meteor.http to HTTP. Backwards compatible. 2013-07-25 18:54:42 -07:00
David Glasser
ce16794cbb Push through on the Meteor.connect -> DDP.connect rename. 2013-07-25 18:54:42 -07:00
Nick Martin
475af49b27 doc tweaks. 2013-07-25 16:55:59 -07:00
Zoltan Olah
853bdb4df2 Documentation for Meteor.disconnect(). 2013-07-25 16:55:59 -07:00
Nick Martin
fc307660ac Add a note about how isServer doesn't strip code from the client. 2013-07-17 19:57:40 -07:00
David Glasser
36275c570c Merge branch 'linker' into devel
some compatibility notes about packages:

  - packages now have their own namespaces (rather than needing to
    use the global namespace).  symbols you want to share should
    be declared with an @export comment

  - this also means that missing dependencies can hurt you. so don't
    leave them out.

  - your app's packages (in the 'packages' directory in your app) are
    not automatically included in your app; you need to explicitly
    run "meteor add" for them.  this means that, eg, you can have test
    helper packages which are not directly used in your app, but just
    used by other packages' tests.  (before releasing this, we may
    make 'meteor update' fix current apps.)

  - the bundle ("star") format has changed

  - packages are now built into the "unipackage" format.  if this format changes
    before we release this code (and commit to the definition of the initial
    versions of the formats) you may need to run "meteor rebuild-all"

  - __meteor_bootstrap__ has been stripped of everything not related to
    executing JS code. Some of what used to be there is now on the WebApp
    object.

more detailed docs are likely to come before the 0.6.5 release.
2013-07-12 13:38:05 -07:00