Tentacat v0.3.0 → Overview → Tentacat → Commits → Comments

Tentacat.Commits.Comments

Summary
Functions

Summary

create(owner, repo, sha, body, client \\ %Tentacat.Client{})	Create a comment for a commit
delete(owner, repo, id, client \\ %Tentacat.Client{})	Delete a comment for a commit
find(owner, repo, id, client \\ %Tentacat.Client{})	Find a comment for a commit
list(owner, repo, ref, client \\ %Tentacat.Client{})	List commit comments for a commit
list_all(owner, repo, client \\ %Tentacat.Client{})	List commit comments in a repository
update(owner, repo, id, body, client \\ %Tentacat.Client{})	Update a comment for a commit

Functions

create(owner, repo, sha, body, client \\ %Tentacat.Client{})

(function) # ↑

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

delete(owner, repo, id, client \\ %Tentacat.Client{})

(function) # ↑

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

find(owner, repo, id, client \\ %Tentacat.Client{})

(function) # ↑

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

list(owner, repo, ref, client \\ %Tentacat.Client{})

(function) # ↑

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

list_all(owner, repo, client \\ %Tentacat.Client{})

(function) # ↑

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

update(owner, repo, id, body, client \\ %Tentacat.Client{})

(function) # ↑

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