Skip to content

Commit 213447d

Browse files
committed
chore: update .gitignore for gh-pages artifacts
* tweak documentation comments for new comment-related Gist functions
1 parent 7bbe75d commit 213447d

File tree

2 files changed

+8
-8
lines changed

2 files changed

+8
-8
lines changed

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.sass-cache/
2+
_site/
13
docs/
24
dist/
35
coverage/

lib/Gist.js

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -108,10 +108,8 @@ class Gist extends Requestable {
108108
return this._request204or404(`/gists/${this.__id}/star`, null, cb);
109109
}
110110

111-
112-
113111
/**
114-
* List the comments on a gist
112+
* List the gist's comments
115113
* @see https://developer.github.com/v3/gists/comments/#list-comments-on-a-gist
116114
* @param {Requestable.callback} [cb] - will receive the array of comments
117115
* @return {Promise} - the promise for the http request
@@ -121,7 +119,7 @@ class Gist extends Requestable {
121119
}
122120

123121
/**
124-
* Fetch a comment of the gist
122+
* Fetch one of the gist's comments
125123
* @see https://developer.github.com/v3/gists/comments/#get-a-single-comment
126124
* @param {number} comment - the id of the comment
127125
* @param {Requestable.callback} [cb] - will receive the comment
@@ -132,7 +130,7 @@ class Gist extends Requestable {
132130
}
133131

134132
/**
135-
* Create Comment to a gist.
133+
* Comment on a gist
136134
* @see https://developer.github.com/v3/gists/comments/#create-a-comment
137135
* @param {string} comment - the comment to add
138136
* @param {Requestable.callback} [cb] - the function that receives the API result
@@ -143,19 +141,19 @@ class Gist extends Requestable {
143141
}
144142

145143
/**
146-
* Edit a Gist Comment
144+
* Edit a comment on the gist
147145
* @see https://developer.github.com/v3/gists/comments/#edit-a-comment
148146
* @param {number} comment - the id of the comment
149147
* @param {string} body - the new comment
150-
* @param {Requestable.callback} [cb] - will receive the modified issue
148+
* @param {Requestable.callback} [cb] - will receive the modified comment
151149
* @return {Promise} - the promise for the http request
152150
*/
153151
editComment(comment, body, cb) {
154152
return this._request('PATCH', `/gists/${this.__id}/comments/${comment}`, {body: body}, cb);
155153
}
156154

157155
/**
158-
* Delete a comment of a gist.
156+
* Delete a comment on the gist.
159157
* @see https://developer.github.com/v3/gists/comments/#delete-a-comment
160158
* @param {number} comment - the id of the comment
161159
* @param {Requestable.callback} [cb] - will receive true if the request succeeds

0 commit comments

Comments
 (0)