gh_compare: Compare two branches

Description Usage Arguments Value

View source: R/repositories.R

Description

https://developer.github.com/v3/repos/commits/#compare-two-commits

Usage

1
gh_compare(base, head, repo, api = getOption("github.api"), ...)

Arguments

base

(string) The base branch name.

head

(string) The branch to compare to the base.

repo

(string) The repository specified as "owner/repo".

api

(string, optional) The address to GitHub's API. Default: Uses the option github.api.

...

Parameters passed to gh_page.

Value

A list describing the commits and the differences (see GitHub's API documentation for details).


ChadGoymer/github documentation built on June 1, 2017, 5:17 p.m.