browse_docs: View GitHub API documentation

In projmgr: Task Tracking and Project Management with GitHub

Description

Opens browser to relevant parts of GitHub API documentation to learn more about field definitions and formatting. Inspired by similar browse_ functions included in the usethis package.

Usage

browse_docs(action = c("get", "post"), object = c("milestone", "issue",
  "issue event", "issue comment", "repo labels"))

Arguments

action	Character string denoting action you wish to complete: "get" (list existing) or "post" (creating new)
object	Character string denoting object on wish you want to apply an action. Supports "milestone", "issue", "issue event"

Value

Returns URL in non-interactive session or launches browser to docs in interactive session

Examples

## Not run: 
browse_docs('get', 'milestone')

## End(Not run)

projmgr documentation built on Aug. 5, 2019, 5:15 p.m.