{"action":"closed","number":170,"pull_request":{"url":"https://api.github.com/repos/scootdev/scoot/pulls/170","id":94051544,"html_url":"https://github.com/scootdev/scoot/pull/170","diff_url":"https://github.com/scootdev/scoot/pull/170.diff","patch_url":"https://github.com/scootdev/scoot/pull/170.patch","issue_url":"https://api.github.com/repos/scootdev/scoot/issues/170","number":170,"state":"closed","locked":false,"title":"scoot: godocs and readmes","user":{"login":"dgassaway","id":3122764,"avatar_url":"https://avatars.githubusercontent.com/u/3122764?v=3","gravatar_id":"","url":"https://api.github.com/users/dgassaway","html_url":"https://github.com/dgassaway","followers_url":"https://api.github.com/users/dgassaway/followers","following_url":"https://api.github.com/users/dgassaway/following{/other_user}","gists_url":"https://api.github.com/users/dgassaway/gists{/gist_id}","starred_url":"https://api.github.com/users/dgassaway/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/dgassaway/subscriptions","organizations_url":"https://api.github.com/users/dgassaway/orgs","repos_url":"https://api.github.com/users/dgassaway/repos","events_url":"https://api.github.com/users/dgassaway/events{/privacy}","received_events_url":"https://api.github.com/users/dgassaway/received_events","type":"User","site_admin":false},"body":"Some general notes:\r\n* No code changes here\r\n* Goal is to make scoot code easier to understand, more discoverable, and set skeleton for more complete docs going forward\r\n* This is not a total doc-style overhaul. But hopefully is useful.\r\n* In general we have a lot of inconsistencies in where we use exported types/funcs, and interfaces vs exported types\r\n\r\nDoc philosophy used here:\r\n* Packages and key exported types and functions should have a godoc-compatible comment\r\n* If the package doc is really long or there's no obvious file for it, throw it in a doc.go file\r\n* Broader diatribes on high level functionality or interaction better suited to readmes\r\n* Probably fewer, more detailed readmes is better than many tiny readmes nested around","created_at":"2016-11-16T21:16:16Z","updated_at":"2016-11-17T20:07:19Z","closed_at":"2016-11-17T20:07:18Z","merged_at":"2016-11-17T20:07:18Z","merge_commit_sha":"be9cbc2d503f32ffa5d690183c7316171579de61","assignee":null,"assignees":[],"milestone":null,"commits_url":"https://api.github.com/repos/scootdev/scoot/pulls/170/commits","review_comments_url":"https://api.github.com/repos/scootdev/scoot/pulls/170/comments","review_comment_url":"https://api.github.com/repos/scootdev/scoot/pulls/comments{/number}","comments_url":"https://api.github.com/repos/scootdev/scoot/issues/170/comments","statuses_url":"https://api.github.com/repos/scootdev/scoot/statuses/c6aaa87e67c073604305e3be231027773a917a5b","head":{"label":"scootdev:dgassaway/scoot207-docs","ref":"dgassaway/scoot207-docs","sha":"c6aaa87e67c073604305e3be231027773a917a5b","user":{"login":"scootdev","id":16392490,"avatar_url":"https://avatars.githubusercontent.com/u/16392490?v=3","gravatar_id":"","url":"https://api.github.com/users/scootdev","html_url":"https://github.com/scootdev","followers_url":"https://api.github.com/users/scootdev/followers","following_url":"https://api.github.com/users/scootdev/following{/other_user}","gists_url":"https://api.github.com/users/scootdev/gists{/gist_id}","starred_url":"https://api.github.com/users/scootdev/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/scootdev/subscriptions","organizations_url":"https://api.github.com/users/scootdev/orgs","repos_url":"https://api.github.com/users/scootdev/repos","events_url":"https://api.github.com/users/scootdev/events{/privacy}","received_events_url":"https://api.github.com/users/scootdev/received_events","type":"Organization","site_admin":false},"repo":{"id":48396966,"name":"scoot","full_name":"scootdev/scoot","owner":{"login":"scootdev","id":16392490,"avatar_url":"https://avatars.githubusercontent.com/u/16392490?v=3","gravatar_id":"","url":"https://api.github.com/users/scootdev","html_url":"https://github.com/scootdev","followers_url":"https://api.github.com/users/scootdev/followers","following_url":"https://api.github.com/users/scootdev/following{/other_user}","gists_url":"https://api.github.com/users/scootdev/gists{/gist_id}","starred_url":"https://api.github.com/users/scootdev/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/scootdev/subscriptions","organizations_url":"https://api.github.com/users/scootdev/orgs","repos_url":"https://api.github.com/users/scootdev/repos","events_url":"https://api.github.com/users/scootdev/events{/privacy}","received_events_url":"https://api.github.com/users/scootdev/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/scootdev/scoot","description":null,"fork":false,"url":"https://api.github.com/repos/scootdev/scoot","forks_url":"https://api.github.com/repos/scootdev/scoot/forks","keys_url":"https://api.github.com/repos/scootdev/scoot/keys{/key_id}","collaborators_url":"https://api.github.com/repos/scootdev/scoot/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/scootdev/scoot/teams","hooks_url":"https://api.github.com/repos/scootdev/scoot/hooks","issue_events_url":"https://api.github.com/repos/scootdev/scoot/issues/events{/number}","events_url":"https://api.github.com/repos/scootdev/scoot/events","assignees_url":"https://api.github.com/repos/scootdev/scoot/assignees{/user}","branches_url":"https://api.github.com/repos/scootdev/scoot/branches{/branch}","tags_url":"https://api.github.com/repos/scootdev/scoot/tags","blobs_url":"https://api.github.com/repos/scootdev/scoot/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/scootdev/scoot/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/scootdev/scoot/git/refs{/sha}","trees_url":"https://api.github.com/repos/scootdev/scoot/git/trees{/sha}","statuses_url":"https://api.github.com/repos/scootdev/scoot/statuses/{sha}","languages_url":"https://api.github.com/repos/scootdev/scoot/languages","stargazers_url":"https://api.github.com/repos/scootdev/scoot/stargazers","contributors_url":"https://api.github.com/repos/scootdev/scoot/contributors","subscribers_url":"https://api.github.com/repos/scootdev/scoot/subscribers","subscription_url":"https://api.github.com/repos/scootdev/scoot/subscription","commits_url":"https://api.github.com/repos/scootdev/scoot/commits{/sha}","git_commits_url":"https://api.github.com/repos/scootdev/scoot/git/commits{/sha}","comments_url":"https://api.github.com/repos/scootdev/scoot/comments{/number}","issue_comment_url":"https://api.github.com/repos/scootdev/scoot/issues/comments{/number}","contents_url":"https://api.github.com/repos/scootdev/scoot/contents/{+path}","compare_url":"https://api.github.com/repos/scootdev/scoot/compare/{base}...{head}","merges_url":"https://api.github.com/repos/scootdev/scoot/merges","archive_url":"https://api.github.com/repos/scootdev/scoot/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/scootdev/scoot/downloads","issues_url":"https://api.github.com/repos/scootdev/scoot/issues{/number}","pulls_url":"https://api.github.com/repos/scootdev/scoot/pulls{/number}","milestones_url":"https://api.github.com/repos/scootdev/scoot/milestones{/number}","notifications_url":"https://api.github.com/repos/scootdev/scoot/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/scootdev/scoot/labels{/name}","releases_url":"https://api.github.com/repos/scootdev/scoot/releases{/id}","deployments_url":"https://api.github.com/repos/scootdev/scoot/deployments","created_at":"2015-12-21T22:14:54Z","updated_at":"2016-10-25T20:21:13Z","pushed_at":"2016-11-17T20:07:18Z","git_url":"git://github.com/scootdev/scoot.git","ssh_url":"git@github.com:scootdev/scoot.git","clone_url":"https://github.com/scootdev/scoot.git","svn_url":"https://github.com/scootdev/scoot","homepage":"","size":8033,"stargazers_count":10,"watchers_count":10,"language":"Go","has_issues":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":4,"mirror_url":null,"open_issues_count":1,"forks":4,"open_issues":1,"watchers":10,"default_branch":"master"}},"base":{"label":"scootdev:master","ref":"master","sha":"8f203530cd8ff0109b266378fd1f21bb9eae44c0","user":{"login":"scootdev","id":16392490,"avatar_url":"https://avatars.githubusercontent.com/u/16392490?v=3","gravatar_id":"","url":"https://api.github.com/users/scootdev","html_url":"https://github.com/scootdev","followers_url":"https://api.github.com/users/scootdev/followers","following_url":"https://api.github.com/users/scootdev/following{/other_user}","gists_url":"https://api.github.com/users/scootdev/gists{/gist_id}","starred_url":"https://api.github.com/users/scootdev/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/scootdev/subscriptions","organizations_url":"https://api.github.com/users/scootdev/orgs","repos_url":"https://api.github.com/users/scootdev/repos","events_url":"https://api.github.com/users/scootdev/events{/privacy}","received_events_url":"https://api.github.com/users/scootdev/received_events","type":"Organization","site_admin":false},"repo":{"id":48396966,"name":"scoot","full_name":"scootdev/scoot","owner":{"login":"scootdev","id":16392490,"avatar_url":"https://avatars.githubusercontent.com/u/16392490?v=3","gravatar_id":"","url":"https://api.github.com/users/scootdev","html_url":"https://github.com/scootdev","followers_url":"https://api.github.com/users/scootdev/followers","following_url":"https://api.github.com/users/scootdev/following{/other_user}","gists_url":"https://api.github.com/users/scootdev/gists{/gist_id}","starred_url":"https://api.github.com/users/scootdev/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/scootdev/subscriptions","organizations_url":"https://api.github.com/users/scootdev/orgs","repos_url":"https://api.github.com/users/scootdev/repos","events_url":"https://api.github.com/users/scootdev/events{/privacy}","received_events_url":"https://api.github.com/users/scootdev/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/scootdev/scoot","description":null,"fork":false,"url":"https://api.github.com/repos/scootdev/scoot","forks_url":"https://api.github.com/repos/scootdev/scoot/forks","keys_url":"https://api.github.com/repos/scootdev/scoot/keys{/key_id}","collaborators_url":"https://api.github.com/repos/scootdev/scoot/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/scootdev/scoot/teams","hooks_url":"https://api.github.com/repos/scootdev/scoot/hooks","issue_events_url":"https://api.github.com/repos/scootdev/scoot/issues/events{/number}","events_url":"https://api.github.com/repos/scootdev/scoot/events","assignees_url":"https://api.github.com/repos/scootdev/scoot/assignees{/user}","branches_url":"https://api.github.com/repos/scootdev/scoot/branches{/branch}","tags_url":"https://api.github.com/repos/scootdev/scoot/tags","blobs_url":"https://api.github.com/repos/scootdev/scoot/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/scootdev/scoot/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/scootdev/scoot/git/refs{/sha}","trees_url":"https://api.github.com/repos/scootdev/scoot/git/trees{/sha}","statuses_url":"https://api.github.com/repos/scootdev/scoot/statuses/{sha}","languages_url":"https://api.github.com/repos/scootdev/scoot/languages","stargazers_url":"https://api.github.com/repos/scootdev/scoot/stargazers","contributors_url":"https://api.github.com/repos/scootdev/scoot/contributors","subscribers_url":"https://api.github.com/repos/scootdev/scoot/subscribers","subscription_url":"https://api.github.com/repos/scootdev/scoot/subscription","commits_url":"https://api.github.com/repos/scootdev/scoot/commits{/sha}","git_commits_url":"https://api.github.com/repos/scootdev/scoot/git/commits{/sha}","comments_url":"https://api.github.com/repos/scootdev/scoot/comments{/number}","issue_comment_url":"https://api.github.com/repos/scootdev/scoot/issues/comments{/number}","contents_url":"https://api.github.com/repos/scootdev/scoot/contents/{+path}","compare_url":"https://api.github.com/repos/scootdev/scoot/compare/{base}...{head}","merges_url":"https://api.github.com/repos/scootdev/scoot/merges","archive_url":"https://api.github.com/repos/scootdev/scoot/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/scootdev/scoot/downloads","issues_url":"https://api.github.com/repos/scootdev/scoot/issues{/number}","pulls_url":"https://api.github.com/repos/scootdev/scoot/pulls{/number}","milestones_url":"https://api.github.com/repos/scootdev/scoot/milestones{/number}","notifications_url":"https://api.github.com/repos/scootdev/scoot/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/scootdev/scoot/labels{/name}","releases_url":"https://api.github.com/repos/scootdev/scoot/releases{/id}","deployments_url":"https://api.github.com/repos/scootdev/scoot/deployments","created_at":"2015-12-21T22:14:54Z","updated_at":"2016-10-25T20:21:13Z","pushed_at":"2016-11-17T20:07:18Z","git_url":"git://github.com/scootdev/scoot.git","ssh_url":"git@github.com:scootdev/scoot.git","clone_url":"https://github.com/scootdev/scoot.git","svn_url":"https://github.com/scootdev/scoot","homepage":"","size":8033,"stargazers_count":10,"watchers_count":10,"language":"Go","has_issues":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":4,"mirror_url":null,"open_issues_count":1,"forks":4,"open_issues":1,"watchers":10,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/scootdev/scoot/pulls/170"},"html":{"href":"https://github.com/scootdev/scoot/pull/170"},"issue":{"href":"https://api.github.com/repos/scootdev/scoot/issues/170"},"comments":{"href":"https://api.github.com/repos/scootdev/scoot/issues/170/comments"},"review_comments":{"href":"https://api.github.com/repos/scootdev/scoot/pulls/170/comments"},"review_comment":{"href":"https://api.github.com/repos/scootdev/scoot/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/scootdev/scoot/pulls/170/commits"},"statuses":{"href":"https://api.github.com/repos/scootdev/scoot/statuses/c6aaa87e67c073604305e3be231027773a917a5b"}},"merged":true,"mergeable":null,"mergeable_state":"unknown","merged_by":{"login":"dgassaway","id":3122764,"avatar_url":"https://avatars.githubusercontent.com/u/3122764?v=3","gravatar_id":"","url":"https://api.github.com/users/dgassaway","html_url":"https://github.com/dgassaway","followers_url":"https://api.github.com/users/dgassaway/followers","following_url":"https://api.github.com/users/dgassaway/following{/other_user}","gists_url":"https://api.github.com/users/dgassaway/gists{/gist_id}","starred_url":"https://api.github.com/users/dgassaway/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/dgassaway/subscriptions","organizations_url":"https://api.github.com/users/dgassaway/orgs","repos_url":"https://api.github.com/users/dgassaway/repos","events_url":"https://api.github.com/users/dgassaway/events{/privacy}","received_events_url":"https://api.github.com/users/dgassaway/received_events","type":"User","site_admin":false},"comments":3,"review_comments":27,"commits":9,"additions":385,"deletions":207,"changed_files":49}}
{"actor":{"display_login":"dgassaway"}}