Documentation updates for new PullOp options.

ajoberstar · Mar 11, 2015 · 44cffc9 · 44cffc9
1 parent 9c5d803
commit 44cffc9
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -52,9 +52,10 @@ If you're interested in a change, please submit an issue (or even better a pull
 
 ## Release Notes
 
-### 1.1.0 (milestone)
+### 1.1.0
 
 * Added `grgit.describe()` method. (Thanks to [Louis Bergulson](https://github.com/lbergelson))
+* Added `branch` and `remote` options to `grgit.pull()`.
 
 ### 1.0.0
 

diff --git a/src/main/groovy/org/ajoberstar/grgit/operation/PullOp.groovy b/src/main/groovy/org/ajoberstar/grgit/operation/PullOp.groovy
@@ -43,6 +43,18 @@ import org.eclipse.jgit.api.errors.GitAPIException
  * grgit.pull(rebase: true)
  * </pre>
  *
+ * <p>Pull changes from another remote.</p>
+ *
+ * <pre>
+ * grgit.pull(remote: 'other-remote')
+ * </pre>
+ *
+ * <p>Pull changes from another branch.</p>
+ *
+ * <pre>
+ * grgit.pull(branch: 'other-branch')
+ * </pre>
+ *
  * See <a href="http://git-scm.com/docs/git-pull">git-pull Manual Page</a>.
  *
  * @since 0.2.0