Merge pull request #935 from smith-kyle/merge-docs

johnhaley81 · johnhaley81 · commit d8f1dae47bbf · 2016-03-07T10:57:16.000-07:00
Docs: improved Merge.merge param docs
diff --git a/lib/merge.js b/lib/merge.js
@@ -29,7 +29,7 @@ Merge.commits = function(repo, ourCommit, theirCommit, options) {
  * Merge a commit into HEAD and writes the results to the working directory.
  *
  * @param {Repository} repo Repository that contains the given commits
- * @param {Commit} theirHead The annotated to merge into HEAD
+ * @param {AnnotatedCommit} theirHead The annotated commit to merge into HEAD
  * @param {MergeOptions} [mergeOpts] The merge tree options (null for default)
  * @param {CheckoutOptions} [checkoutOpts] The checkout options
  *                                         (null for default)

Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,7 @@ Merge.commits = function(repo, ourCommit, theirCommit, options) {`
`29`	`29`	`* Merge a commit into HEAD and writes the results to the working directory.`
`30`	`30`	`*`
`31`	`31`	`* @param {Repository} repo Repository that contains the given commits`
`32`		`- * @param {Commit} theirHead The annotated to merge into HEAD`
	`32`	`+ * @param {AnnotatedCommit} theirHead The annotated commit to merge into HEAD`
`33`	`33`	`* @param {MergeOptions} [mergeOpts] The merge tree options (null for default)`
`34`	`34`	`* @param {CheckoutOptions} [checkoutOpts] The checkout options`
`35`	`35`	`* (null for default)`