From 300fc92b7032d33e353e97212c2f108bcb30a0b9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Christoph=20H=C3=BCsler?= Date: Wed, 25 Feb 2015 09:22:41 +0100 Subject: [PATCH 1/2] Update 'pull' documentation to not talk about 'push' The documentation of 'pull' seems to be a c&p of the 'push' one. This matches what I'm seeing in the code/my tests. --- docs/js-api.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/docs/js-api.md b/docs/js-api.md index d11ddf74..f59e8f19 100644 --- a/docs/js-api.md +++ b/docs/js-api.md @@ -303,12 +303,10 @@ Synchronizes local dat with a remote dat by pushing all changes to the remote da ## pull ```js -dat.push(remote, [cb]) +dat.pull([cb]) ``` -Synchronizes local dat with a remote dat by pushing all changes to the remote dat over HTTP. Calls `cb` with `(err)` when done. - -`remote` should be the base HTTP address of the remote dat, e.g. `http://localhost:6461` +Synchronizes local dat with the remote dat this one was cloned from by pulling all changes from the remote dat over HTTP. Calls `cb` when done. ### Options From a9c8f4963ebe8e406abe86c81de9cd77158bb95b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Christoph=20H=C3=BCsler?= Date: Wed, 25 Feb 2015 11:08:53 +0100 Subject: [PATCH 2/2] add remote back in Add remote back in. --- docs/js-api.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/js-api.md b/docs/js-api.md index f59e8f19..39de16fa 100644 --- a/docs/js-api.md +++ b/docs/js-api.md @@ -303,10 +303,12 @@ Synchronizes local dat with a remote dat by pushing all changes to the remote da ## pull ```js -dat.pull([cb]) +dat.pull([remote], [cb]) ``` -Synchronizes local dat with the remote dat this one was cloned from by pulling all changes from the remote dat over HTTP. Calls `cb` when done. +Synchronizes local dat with the remote dat by pulling all changes from the remote dat over HTTP. Calls `cb` when done. + +`remote` (default: the url this one was cloned from) should be the base HTTP address of the remote dat, e.g. `http://localhost:6461`. ### Options