{"action":"created","comment":{"url":"https://api.github.com/repos/codeclimate/spec/pulls/comments/62919699","id":62919699,"diff_hunk":"@@ -38,11 +38,14 @@ The `include_paths` key will always be present in `config.json`, and must be use\n \n ## Output\n \n-Engines stream static analysis Issues to STDOUT in JSON format. When possible, results should be emitted as soon as they are computed (streaming, not buffered). Each issue is terminated by the [null character][null] (`\\0` in most programming languages), but can additionally be separated by newlines.\n-\n-Unstructured information can be printed on STDERR for the purposes of aiding debugging. Note that STDERR output will only be displayed in the console output when there is a failure, so this approach may not be appropriate for general purpose logging.\n-\n-An engine must exit with a zero exit code to be considered a success. Any nonzero exit code indicates a fatal error in the static analysis and the results for the entire analysis will be discarded (even if some were previously emitted).\n+* Engines must stream Issues to `STDOUT` in JSON format.\n+* When possible, results should be emitted as soon as they are computed (streamed, not buffered).\n+* Each issue must be terminated by the [null character][null] (`\\0` in most programming languages), but can additionally be separated by newlines.\n+* Unstructured information can be printed on STDERR for the purposes of aiding debugging.\n+  * *Note that STDERR output will only be displayed in console output when there is a failure, so this approach is not appropriate for general purpose logging.*","path":"SPEC.md","position":13,"original_position":13,"commit_id":"e1f853a9fc35db34b448ff8f79a25ab92dbb7630","original_commit_id":"e1f853a9fc35db34b448ff8f79a25ab92dbb7630","user":{"login":"wfleming","id":188402,"avatar_url":"https://avatars.githubusercontent.com/u/188402?v=3","gravatar_id":"","url":"https://api.github.com/users/wfleming","html_url":"https://github.com/wfleming","followers_url":"https://api.github.com/users/wfleming/followers","following_url":"https://api.github.com/users/wfleming/following{/other_user}","gists_url":"https://api.github.com/users/wfleming/gists{/gist_id}","starred_url":"https://api.github.com/users/wfleming/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/wfleming/subscriptions","organizations_url":"https://api.github.com/users/wfleming/orgs","repos_url":"https://api.github.com/users/wfleming/repos","events_url":"https://api.github.com/users/wfleming/events{/privacy}","received_events_url":"https://api.github.com/users/wfleming/received_events","type":"User","site_admin":false},"body":"Heh. I wrote that code.","created_at":"2016-05-11T20:23:26Z","updated_at":"2016-05-11T20:23:26Z","html_url":"https://github.com/codeclimate/spec/pull/43#discussion_r62919699","pull_request_url":"https://api.github.com/repos/codeclimate/spec/pulls/43","_links":{"self":{"href":"https://api.github.com/repos/codeclimate/spec/pulls/comments/62919699"},"html":{"href":"https://github.com/codeclimate/spec/pull/43#discussion_r62919699"},"pull_request":{"href":"https://api.github.com/repos/codeclimate/spec/pulls/43"}}},"pull_request":{"url":"https://api.github.com/repos/codeclimate/spec/pulls/43","id":69733929,"html_url":"https://github.com/codeclimate/spec/pull/43","diff_url":"https://github.com/codeclimate/spec/pull/43.diff","patch_url":"https://github.com/codeclimate/spec/pull/43.patch","issue_url":"https://api.github.com/repos/codeclimate/spec/issues/43","number":43,"state":"open","locked":false,"title":"Clarify some language in the output section","user":{"login":"mrb","id":2878,"avatar_url":"https://avatars.githubusercontent.com/u/2878?v=3","gravatar_id":"","url":"https://api.github.com/users/mrb","html_url":"https://github.com/mrb","followers_url":"https://api.github.com/users/mrb/followers","following_url":"https://api.github.com/users/mrb/following{/other_user}","gists_url":"https://api.github.com/users/mrb/gists{/gist_id}","starred_url":"https://api.github.com/users/mrb/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/mrb/subscriptions","organizations_url":"https://api.github.com/users/mrb/orgs","repos_url":"https://api.github.com/users/mrb/repos","events_url":"https://api.github.com/users/mrb/events{/privacy}","received_events_url":"https://api.github.com/users/mrb/received_events","type":"User","site_admin":false},"body":"","created_at":"2016-05-11T20:07:56Z","updated_at":"2016-05-11T20:23:26Z","closed_at":null,"merged_at":null,"merge_commit_sha":"8d653eebf4a83a1b35c5cad30fbc37725b6cfaf3","assignee":null,"milestone":null,"commits_url":"https://api.github.com/repos/codeclimate/spec/pulls/43/commits","review_comments_url":"https://api.github.com/repos/codeclimate/spec/pulls/43/comments","review_comment_url":"https://api.github.com/repos/codeclimate/spec/pulls/comments{/number}","comments_url":"https://api.github.com/repos/codeclimate/spec/issues/43/comments","statuses_url":"https://api.github.com/repos/codeclimate/spec/statuses/e1f853a9fc35db34b448ff8f79a25ab92dbb7630","head":{"label":"codeclimate:clear_up_output_section","ref":"clear_up_output_section","sha":"e1f853a9fc35db34b448ff8f79a25ab92dbb7630","user":{"login":"codeclimate","id":789641,"avatar_url":"https://avatars.githubusercontent.com/u/789641?v=3","gravatar_id":"","url":"https://api.github.com/users/codeclimate","html_url":"https://github.com/codeclimate","followers_url":"https://api.github.com/users/codeclimate/followers","following_url":"https://api.github.com/users/codeclimate/following{/other_user}","gists_url":"https://api.github.com/users/codeclimate/gists{/gist_id}","starred_url":"https://api.github.com/users/codeclimate/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/codeclimate/subscriptions","organizations_url":"https://api.github.com/users/codeclimate/orgs","repos_url":"https://api.github.com/users/codeclimate/repos","events_url":"https://api.github.com/users/codeclimate/events{/privacy}","received_events_url":"https://api.github.com/users/codeclimate/received_events","type":"Organization","site_admin":false},"repo":{"id":37724413,"name":"spec","full_name":"codeclimate/spec","owner":{"login":"codeclimate","id":789641,"avatar_url":"https://avatars.githubusercontent.com/u/789641?v=3","gravatar_id":"","url":"https://api.github.com/users/codeclimate","html_url":"https://github.com/codeclimate","followers_url":"https://api.github.com/users/codeclimate/followers","following_url":"https://api.github.com/users/codeclimate/following{/other_user}","gists_url":"https://api.github.com/users/codeclimate/gists{/gist_id}","starred_url":"https://api.github.com/users/codeclimate/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/codeclimate/subscriptions","organizations_url":"https://api.github.com/users/codeclimate/orgs","repos_url":"https://api.github.com/users/codeclimate/repos","events_url":"https://api.github.com/users/codeclimate/events{/privacy}","received_events_url":"https://api.github.com/users/codeclimate/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/codeclimate/spec","description":"Code Climate Engines Specification","fork":false,"url":"https://api.github.com/repos/codeclimate/spec","forks_url":"https://api.github.com/repos/codeclimate/spec/forks","keys_url":"https://api.github.com/repos/codeclimate/spec/keys{/key_id}","collaborators_url":"https://api.github.com/repos/codeclimate/spec/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/codeclimate/spec/teams","hooks_url":"https://api.github.com/repos/codeclimate/spec/hooks","issue_events_url":"https://api.github.com/repos/codeclimate/spec/issues/events{/number}","events_url":"https://api.github.com/repos/codeclimate/spec/events","assignees_url":"https://api.github.com/repos/codeclimate/spec/assignees{/user}","branches_url":"https://api.github.com/repos/codeclimate/spec/branches{/branch}","tags_url":"https://api.github.com/repos/codeclimate/spec/tags","blobs_url":"https://api.github.com/repos/codeclimate/spec/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/codeclimate/spec/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/codeclimate/spec/git/refs{/sha}","trees_url":"https://api.github.com/repos/codeclimate/spec/git/trees{/sha}","statuses_url":"https://api.github.com/repos/codeclimate/spec/statuses/{sha}","languages_url":"https://api.github.com/repos/codeclimate/spec/languages","stargazers_url":"https://api.github.com/repos/codeclimate/spec/stargazers","contributors_url":"https://api.github.com/repos/codeclimate/spec/contributors","subscribers_url":"https://api.github.com/repos/codeclimate/spec/subscribers","subscription_url":"https://api.github.com/repos/codeclimate/spec/subscription","commits_url":"https://api.github.com/repos/codeclimate/spec/commits{/sha}","git_commits_url":"https://api.github.com/repos/codeclimate/spec/git/commits{/sha}","comments_url":"https://api.github.com/repos/codeclimate/spec/comments{/number}","issue_comment_url":"https://api.github.com/repos/codeclimate/spec/issues/comments{/number}","contents_url":"https://api.github.com/repos/codeclimate/spec/contents/{+path}","compare_url":"https://api.github.com/repos/codeclimate/spec/compare/{base}...{head}","merges_url":"https://api.github.com/repos/codeclimate/spec/merges","archive_url":"https://api.github.com/repos/codeclimate/spec/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/codeclimate/spec/downloads","issues_url":"https://api.github.com/repos/codeclimate/spec/issues{/number}","pulls_url":"https://api.github.com/repos/codeclimate/spec/pulls{/number}","milestones_url":"https://api.github.com/repos/codeclimate/spec/milestones{/number}","notifications_url":"https://api.github.com/repos/codeclimate/spec/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/codeclimate/spec/labels{/name}","releases_url":"https://api.github.com/repos/codeclimate/spec/releases{/id}","deployments_url":"https://api.github.com/repos/codeclimate/spec/deployments","created_at":"2015-06-19T13:51:27Z","updated_at":"2016-04-22T23:08:03Z","pushed_at":"2016-05-11T20:07:57Z","git_url":"git://github.com/codeclimate/spec.git","ssh_url":"git@github.com:codeclimate/spec.git","clone_url":"https://github.com/codeclimate/spec.git","svn_url":"https://github.com/codeclimate/spec","homepage":"https://codeclimate.com/platform","size":244,"stargazers_count":57,"watchers_count":57,"language":null,"has_issues":true,"has_downloads":true,"has_wiki":false,"has_pages":false,"forks_count":8,"mirror_url":null,"open_issues_count":3,"forks":8,"open_issues":3,"watchers":57,"default_branch":"master"}},"base":{"label":"codeclimate:master","ref":"master","sha":"8bb17afa6e6961f2890ba680ae33d48d47039caa","user":{"login":"codeclimate","id":789641,"avatar_url":"https://avatars.githubusercontent.com/u/789641?v=3","gravatar_id":"","url":"https://api.github.com/users/codeclimate","html_url":"https://github.com/codeclimate","followers_url":"https://api.github.com/users/codeclimate/followers","following_url":"https://api.github.com/users/codeclimate/following{/other_user}","gists_url":"https://api.github.com/users/codeclimate/gists{/gist_id}","starred_url":"https://api.github.com/users/codeclimate/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/codeclimate/subscriptions","organizations_url":"https://api.github.com/users/codeclimate/orgs","repos_url":"https://api.github.com/users/codeclimate/repos","events_url":"https://api.github.com/users/codeclimate/events{/privacy}","received_events_url":"https://api.github.com/users/codeclimate/received_events","type":"Organization","site_admin":false},"repo":{"id":37724413,"name":"spec","full_name":"codeclimate/spec","owner":{"login":"codeclimate","id":789641,"avatar_url":"https://avatars.githubusercontent.com/u/789641?v=3","gravatar_id":"","url":"https://api.github.com/users/codeclimate","html_url":"https://github.com/codeclimate","followers_url":"https://api.github.com/users/codeclimate/followers","following_url":"https://api.github.com/users/codeclimate/following{/other_user}","gists_url":"https://api.github.com/users/codeclimate/gists{/gist_id}","starred_url":"https://api.github.com/users/codeclimate/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/codeclimate/subscriptions","organizations_url":"https://api.github.com/users/codeclimate/orgs","repos_url":"https://api.github.com/users/codeclimate/repos","events_url":"https://api.github.com/users/codeclimate/events{/privacy}","received_events_url":"https://api.github.com/users/codeclimate/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/codeclimate/spec","description":"Code Climate Engines Specification","fork":false,"url":"https://api.github.com/repos/codeclimate/spec","forks_url":"https://api.github.com/repos/codeclimate/spec/forks","keys_url":"https://api.github.com/repos/codeclimate/spec/keys{/key_id}","collaborators_url":"https://api.github.com/repos/codeclimate/spec/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/codeclimate/spec/teams","hooks_url":"https://api.github.com/repos/codeclimate/spec/hooks","issue_events_url":"https://api.github.com/repos/codeclimate/spec/issues/events{/number}","events_url":"https://api.github.com/repos/codeclimate/spec/events","assignees_url":"https://api.github.com/repos/codeclimate/spec/assignees{/user}","branches_url":"https://api.github.com/repos/codeclimate/spec/branches{/branch}","tags_url":"https://api.github.com/repos/codeclimate/spec/tags","blobs_url":"https://api.github.com/repos/codeclimate/spec/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/codeclimate/spec/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/codeclimate/spec/git/refs{/sha}","trees_url":"https://api.github.com/repos/codeclimate/spec/git/trees{/sha}","statuses_url":"https://api.github.com/repos/codeclimate/spec/statuses/{sha}","languages_url":"https://api.github.com/repos/codeclimate/spec/languages","stargazers_url":"https://api.github.com/repos/codeclimate/spec/stargazers","contributors_url":"https://api.github.com/repos/codeclimate/spec/contributors","subscribers_url":"https://api.github.com/repos/codeclimate/spec/subscribers","subscription_url":"https://api.github.com/repos/codeclimate/spec/subscription","commits_url":"https://api.github.com/repos/codeclimate/spec/commits{/sha}","git_commits_url":"https://api.github.com/repos/codeclimate/spec/git/commits{/sha}","comments_url":"https://api.github.com/repos/codeclimate/spec/comments{/number}","issue_comment_url":"https://api.github.com/repos/codeclimate/spec/issues/comments{/number}","contents_url":"https://api.github.com/repos/codeclimate/spec/contents/{+path}","compare_url":"https://api.github.com/repos/codeclimate/spec/compare/{base}...{head}","merges_url":"https://api.github.com/repos/codeclimate/spec/merges","archive_url":"https://api.github.com/repos/codeclimate/spec/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/codeclimate/spec/downloads","issues_url":"https://api.github.com/repos/codeclimate/spec/issues{/number}","pulls_url":"https://api.github.com/repos/codeclimate/spec/pulls{/number}","milestones_url":"https://api.github.com/repos/codeclimate/spec/milestones{/number}","notifications_url":"https://api.github.com/repos/codeclimate/spec/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/codeclimate/spec/labels{/name}","releases_url":"https://api.github.com/repos/codeclimate/spec/releases{/id}","deployments_url":"https://api.github.com/repos/codeclimate/spec/deployments","created_at":"2015-06-19T13:51:27Z","updated_at":"2016-04-22T23:08:03Z","pushed_at":"2016-05-11T20:07:57Z","git_url":"git://github.com/codeclimate/spec.git","ssh_url":"git@github.com:codeclimate/spec.git","clone_url":"https://github.com/codeclimate/spec.git","svn_url":"https://github.com/codeclimate/spec","homepage":"https://codeclimate.com/platform","size":244,"stargazers_count":57,"watchers_count":57,"language":null,"has_issues":true,"has_downloads":true,"has_wiki":false,"has_pages":false,"forks_count":8,"mirror_url":null,"open_issues_count":3,"forks":8,"open_issues":3,"watchers":57,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/codeclimate/spec/pulls/43"},"html":{"href":"https://github.com/codeclimate/spec/pull/43"},"issue":{"href":"https://api.github.com/repos/codeclimate/spec/issues/43"},"comments":{"href":"https://api.github.com/repos/codeclimate/spec/issues/43/comments"},"review_comments":{"href":"https://api.github.com/repos/codeclimate/spec/pulls/43/comments"},"review_comment":{"href":"https://api.github.com/repos/codeclimate/spec/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/codeclimate/spec/pulls/43/commits"},"statuses":{"href":"https://api.github.com/repos/codeclimate/spec/statuses/e1f853a9fc35db34b448ff8f79a25ab92dbb7630"}}}}