Tentacat v0.7.2 Tentacat.Commits.Comments
Summary
Functions
Create a comment for a commit
Delete a comment for a commit
Find a comment for a commit
List commit comments for a commit
List commit comments in a repository
Update a comment for a commit
Functions
Specs
create(binary, binary, binary, map | list, Tentacat.Client.t) :: Tentacat.response
Create a comment for a commit
Comment body example:
%{
"body" => "Nice change",
"path" => "file1.txt",
"position" => 4,
"line" => null
}
Example
Tentacat.Commits.Comments.create "elixir-lang", "elixir", "7491bda5196f78536e5acc9b7c90a97170e4db0a", comment_body
More info at: https://developer.github.com/v3/repos/comments/#create-a-commit-comment
Specs
delete(binary, binary, binary | integer, Tentacat.Client.t) :: Tentacat.response
Delete a comment for a commit
Example
Tentacat.Commits.Comments.delete "elixir-lang", "elixir", 1
More info at: https://developer.github.com/v3/repos/comments/#delete-a-commit-comment
Specs
find(binary, binary, binary | integer, Tentacat.Client.t) :: Tentacat.response
Find a comment for a commit
Example
Tentacat.Commits.Comments.find "elixir-lang", "elixir", 1
More info at: https://developer.github.com/v3/repos/comments/#get-a-single-commit-comment
Specs
list(binary, binary, binary, Tentacat.Client.t) :: Tentacat.response
List commit comments for a commit
Example
Tentacat.Commits.Comments.list "elixir-lang", "elixir", "7491bda5196f78536e5acc9b7c90a97170e4db0a"
More info at: https://developer.github.com/v3/repos/comments/#list-comments-for-a-single-commit
Specs
list_all(binary, binary, Tentacat.Client.t) :: Tentacat.response
List commit comments in a repository
Example
Tentacat.Commits.Comments.list_all "elixir-lang", "elixir"
More info at: https://developer.github.com/v3/repos/comments/#list-commit-comments-for-a-repository
Specs
update(binary, binary, binary | integer, map | list, Tentacat.Client.t) :: Tentacat.response
Update a comment for a commit
Comment body example:
%{
"body" => "Nice change",
}
Example
Tentacat.Commits.Comments.update "elixir-lang", "elixir", 1
More info at: https://developer.github.com/v3/repos/comments/#update-a-commit-comment