Merge pull request nodegit#1203 from rcjsuen/patch-2

maxkorp · web-flow · commit 3e065305bbcf · 2017-01-30T11:06:45.000-07:00
Specify acceptable types for `lookup` and `dwim` in Reference
diff --git a/lib/reset.js b/lib/reset.js
@@ -10,8 +10,8 @@ var _reset = Reset.reset;
  *
  * @async
  * @param {Repository} repo Repository where to perform the reset operation.
- * @param {Object} target The committish which content will be used to reset the
- *                        content of the index.
+ * @param {Commit|Tag} target The committish which content will be used to reset
+ *                        the content of the index.
  * @param {Strarray} pathspecs List of pathspecs to operate on.
  *
  * @return {Number} 0 on success or an error code
@@ -26,11 +26,12 @@ Reset.default = function(repo, target, pathspecs) {
  * @async
  * @param {Repository} repo Repository where to perform the reset operation.
  *
- * @param {Object} target Committish to which the Head should be moved to. This
- *                        object must belong to the given `repo` and can either
- *                        be a git_commit or a git_tag. When a git_tag is being
- *                        passed, it should be dereferencable to a git_commit
- *                        which oid will be used as the target of the branch.
+ * @param {Commit|Tag} target Committish to which the Head should be moved to.
+ *                        This object must belong to the given `repo` and can
+ *                        either be a git_commit or a git_tag. When a git_tag is
+ *                        being passed, it should be dereferencable to a
+ *                        git_commit which oid will be used as the target of the
+ *                        branch.
  * @param {Number} resetType Kind of reset operation to perform.
  *
  * @param {CheckoutOptions} opts Checkout options to be used for a HARD reset.
