{"action":"created","comment":{"url":"https://api.github.com/repos/sarif-standard/sarif-spec/pulls/comments/46104365","id":46104365,"diff_hunk":"@@ -348,38 +352,38 @@ This shall be one of the following:\n *\t`Tiger`\n *\t`Whirlpool`\n \n-## `issue` object { #issue }\n+## `result` object { #result }\n \n-### General { #issue-General }\n+### General { #result-General }\n \n-An `issue` object describes a single issue detected by a static analysis tool.\n+A `result` object describes a single result produced by a static analysis tool.\n \n-### `ruleId` property { #issue-ruleId }\n+### `ruleId` property { #result-ruleId }\n \n-An `issue` object shall contain a property named `ruleId` whose value is a string containing\n-a stable, opaque identifier for the rule that was violated.\n+A `result` object shall contain a property named `ruleId` whose value is a string containing\n+a stable, opaque identifier for the rule that was evaluated to produce the result.\n \n ~ IsoExample\n `\"CA2101\"`\n ~\n \n-### `fullMessage` property { #issue-fullMessage }\n+### `fullMessage` property { #result-fullMessage }\n \n-An `issue` object shall contain a property named `fullMessage` whose value is a string that describes the issue.\n+A `result` object shall contain a property named `fullMessage` whose value is a string that describes the result.\n \n-The `fullMessage` property should provide sufficient details to allow an end user to resolve the issue.\n-In particular, `fullMessage` shall include all of the following information that is available and relevant to the issue:\n+The `fullMessage` property should provide sufficient details to allow an end user to resolve any problem that the result might indicate.\n+In particular, `fullMessage` shall include all of the following information that is available and relevant to the result:\n \n-*\tInformation sufficient to identify the analysis target, and the location within the target where the issue occurred.\n+*\tInformation sufficient to identify the analysis target, and the location within the target where the result occurred.\n \n-*\tThe condition within the analysis target that led to the issue being reported.\n+*\tThe condition within the analysis target that led to the result being reported.\n \n-*\tThe risks or problems potentially associated with not fixing the problem.\n+*\tThe risks or problems potentially associated with not fixing the problem indicated by the result, if any.","path":"document/CoreFormat.mdk","position":198,"original_position":198,"commit_id":"d66a07d899e56f40f3d00394ac9f2e476ef3ca53","original_commit_id":"d66a07d899e56f40f3d00394ac9f2e476ef3ca53","user":{"login":"michaelcfanning","id":13526455,"avatar_url":"https://avatars.githubusercontent.com/u/13526455?v=3","gravatar_id":"","url":"https://api.github.com/users/michaelcfanning","html_url":"https://github.com/michaelcfanning","followers_url":"https://api.github.com/users/michaelcfanning/followers","following_url":"https://api.github.com/users/michaelcfanning/following{/other_user}","gists_url":"https://api.github.com/users/michaelcfanning/gists{/gist_id}","starred_url":"https://api.github.com/users/michaelcfanning/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/michaelcfanning/subscriptions","organizations_url":"https://api.github.com/users/michaelcfanning/orgs","repos_url":"https://api.github.com/users/michaelcfanning/repos","events_url":"https://api.github.com/users/michaelcfanning/events{/privacy}","received_events_url":"https://api.github.com/users/michaelcfanning/received_events","type":"User","site_admin":false},"body":"i'd drop this addition, since you've made it clear that this included information is relevant only to problems.","created_at":"2015-11-30T02:26:31Z","updated_at":"2015-11-30T02:26:31Z","html_url":"https://github.com/sarif-standard/sarif-spec/pull/47#discussion_r46104365","pull_request_url":"https://api.github.com/repos/sarif-standard/sarif-spec/pulls/47","_links":{"self":{"href":"https://api.github.com/repos/sarif-standard/sarif-spec/pulls/comments/46104365"},"html":{"href":"https://github.com/sarif-standard/sarif-spec/pull/47#discussion_r46104365"},"pull_request":{"href":"https://api.github.com/repos/sarif-standard/sarif-spec/pulls/47"}}},"pull_request":{"url":"https://api.github.com/repos/sarif-standard/sarif-spec/pulls/47","id":52069529,"html_url":"https://github.com/sarif-standard/sarif-spec/pull/47","diff_url":"https://github.com/sarif-standard/sarif-spec/pull/47.diff","patch_url":"https://github.com/sarif-standard/sarif-spec/pull/47.patch","issue_url":"https://api.github.com/repos/sarif-standard/sarif-spec/issues/47","number":47,"state":"open","locked":false,"title":"Rename \"issue\" to \"result\" throughout","user":{"login":"lgolding","id":11762653,"avatar_url":"https://avatars.githubusercontent.com/u/11762653?v=3","gravatar_id":"","url":"https://api.github.com/users/lgolding","html_url":"https://github.com/lgolding","followers_url":"https://api.github.com/users/lgolding/followers","following_url":"https://api.github.com/users/lgolding/following{/other_user}","gists_url":"https://api.github.com/users/lgolding/gists{/gist_id}","starred_url":"https://api.github.com/users/lgolding/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/lgolding/subscriptions","organizations_url":"https://api.github.com/users/lgolding/orgs","repos_url":"https://api.github.com/users/lgolding/repos","events_url":"https://api.github.com/users/lgolding/events{/privacy}","received_events_url":"https://api.github.com/users/lgolding/received_events","type":"User","site_admin":false},"body":"This is more than just a mechanical change. Until now, we have used the term \"issue\" to mean both \"a condition detected by a tool\" and \"a potentially undesirable condition\". Not all conditions detected\r\nby tools are undersirable, and so we now use two terms:\r\n\r\n* A \"result\" is any condition detected and reported by a tool.\r\n\r\n* A \"problem\" is a potentially undesirable condition indicated by a result.\r\n\r\nIn contexts where a result might or might not indicate a problem, we write \"the problem indicated by the result, if any.\"\r\n\r\nWe change \"detects an issue\" to \"produces a result\", and similar changes in similar constructions.\r\n\r\nWe speak of a rule being \"evaluated to produce a result\" rather than being \"violated\".\r\n\r\nWe make corresponding changes from \"issue log viewer\" to \"result log viewer\", \"issue management system\" to \"result management system\", etc.\r\n\r\n@michaelcfanning @nguerrera ","created_at":"2015-11-29T20:00:52Z","updated_at":"2015-11-30T02:26:31Z","closed_at":null,"merged_at":null,"merge_commit_sha":"a488e43a37c6bfd6fac4b8a64d26129540d16ae2","assignee":null,"milestone":null,"commits_url":"https://api.github.com/repos/sarif-standard/sarif-spec/pulls/47/commits","review_comments_url":"https://api.github.com/repos/sarif-standard/sarif-spec/pulls/47/comments","review_comment_url":"https://api.github.com/repos/sarif-standard/sarif-spec/pulls/comments{/number}","comments_url":"https://api.github.com/repos/sarif-standard/sarif-spec/issues/47/comments","statuses_url":"https://api.github.com/repos/sarif-standard/sarif-spec/statuses/d66a07d899e56f40f3d00394ac9f2e476ef3ca53","head":{"label":"sarif-standard:issue-result","ref":"issue-result","sha":"d66a07d899e56f40f3d00394ac9f2e476ef3ca53","user":{"login":"sarif-standard","id":13755421,"avatar_url":"https://avatars.githubusercontent.com/u/13755421?v=3","gravatar_id":"","url":"https://api.github.com/users/sarif-standard","html_url":"https://github.com/sarif-standard","followers_url":"https://api.github.com/users/sarif-standard/followers","following_url":"https://api.github.com/users/sarif-standard/following{/other_user}","gists_url":"https://api.github.com/users/sarif-standard/gists{/gist_id}","starred_url":"https://api.github.com/users/sarif-standard/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/sarif-standard/subscriptions","organizations_url":"https://api.github.com/users/sarif-standard/orgs","repos_url":"https://api.github.com/users/sarif-standard/repos","events_url":"https://api.github.com/users/sarif-standard/events{/privacy}","received_events_url":"https://api.github.com/users/sarif-standard/received_events","type":"Organization","site_admin":false},"repo":{"id":40567795,"name":"sarif-spec","full_name":"sarif-standard/sarif-spec","owner":{"login":"sarif-standard","id":13755421,"avatar_url":"https://avatars.githubusercontent.com/u/13755421?v=3","gravatar_id":"","url":"https://api.github.com/users/sarif-standard","html_url":"https://github.com/sarif-standard","followers_url":"https://api.github.com/users/sarif-standard/followers","following_url":"https://api.github.com/users/sarif-standard/following{/other_user}","gists_url":"https://api.github.com/users/sarif-standard/gists{/gist_id}","starred_url":"https://api.github.com/users/sarif-standard/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/sarif-standard/subscriptions","organizations_url":"https://api.github.com/users/sarif-standard/orgs","repos_url":"https://api.github.com/users/sarif-standard/repos","events_url":"https://api.github.com/users/sarif-standard/events{/privacy}","received_events_url":"https://api.github.com/users/sarif-standard/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/sarif-standard/sarif-spec","description":"The specification document for the Static Analysis Results Interchange Format (SARIF)","fork":false,"url":"https://api.github.com/repos/sarif-standard/sarif-spec","forks_url":"https://api.github.com/repos/sarif-standard/sarif-spec/forks","keys_url":"https://api.github.com/repos/sarif-standard/sarif-spec/keys{/key_id}","collaborators_url":"https://api.github.com/repos/sarif-standard/sarif-spec/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/sarif-standard/sarif-spec/teams","hooks_url":"https://api.github.com/repos/sarif-standard/sarif-spec/hooks","issue_events_url":"https://api.github.com/repos/sarif-standard/sarif-spec/issues/events{/number}","events_url":"https://api.github.com/repos/sarif-standard/sarif-spec/events","assignees_url":"https://api.github.com/repos/sarif-standard/sarif-spec/assignees{/user}","branches_url":"https://api.github.com/repos/sarif-standard/sarif-spec/branches{/branch}","tags_url":"https://api.github.com/repos/sarif-standard/sarif-spec/tags","blobs_url":"https://api.github.com/repos/sarif-standard/sarif-spec/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/sarif-standard/sarif-spec/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/sarif-standard/sarif-spec/git/refs{/sha}","trees_url":"https://api.github.com/repos/sarif-standard/sarif-spec/git/trees{/sha}","statuses_url":"https://api.github.com/repos/sarif-standard/sarif-spec/statuses/{sha}","languages_url":"https://api.github.com/repos/sarif-standard/sarif-spec/languages","stargazers_url":"https://api.github.com/repos/sarif-standard/sarif-spec/stargazers","contributors_url":"https://api.github.com/repos/sarif-standard/sarif-spec/contributors","subscribers_url":"https://api.github.com/repos/sarif-standard/sarif-spec/subscribers","subscription_url":"https://api.github.com/repos/sarif-standard/sarif-spec/subscription","commits_url":"https://api.github.com/repos/sarif-standard/sarif-spec/commits{/sha}","git_commits_url":"https://api.github.com/repos/sarif-standard/sarif-spec/git/commits{/sha}","comments_url":"https://api.github.com/repos/sarif-standard/sarif-spec/comments{/number}","issue_comment_url":"https://api.github.com/repos/sarif-standard/sarif-spec/issues/comments{/number}","contents_url":"https://api.github.com/repos/sarif-standard/sarif-spec/contents/{+path}","compare_url":"https://api.github.com/repos/sarif-standard/sarif-spec/compare/{base}...{head}","merges_url":"https://api.github.com/repos/sarif-standard/sarif-spec/merges","archive_url":"https://api.github.com/repos/sarif-standard/sarif-spec/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/sarif-standard/sarif-spec/downloads","issues_url":"https://api.github.com/repos/sarif-standard/sarif-spec/issues{/number}","pulls_url":"https://api.github.com/repos/sarif-standard/sarif-spec/pulls{/number}","milestones_url":"https://api.github.com/repos/sarif-standard/sarif-spec/milestones{/number}","notifications_url":"https://api.github.com/repos/sarif-standard/sarif-spec/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/sarif-standard/sarif-spec/labels{/name}","releases_url":"https://api.github.com/repos/sarif-standard/sarif-spec/releases{/id}","created_at":"2015-08-11T22:14:51Z","updated_at":"2015-11-03T23:57:50Z","pushed_at":"2015-11-29T20:00:53Z","git_url":"git://github.com/sarif-standard/sarif-spec.git","ssh_url":"git@github.com:sarif-standard/sarif-spec.git","clone_url":"https://github.com/sarif-standard/sarif-spec.git","svn_url":"https://github.com/sarif-standard/sarif-spec","homepage":null,"size":388,"stargazers_count":5,"watchers_count":5,"language":"HTML","has_issues":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":2,"mirror_url":null,"open_issues_count":29,"forks":2,"open_issues":29,"watchers":5,"default_branch":"master"}},"base":{"label":"sarif-standard:master","ref":"master","sha":"e4a6d9a0f276aeee015cb9232c7e92ae4959f037","user":{"login":"sarif-standard","id":13755421,"avatar_url":"https://avatars.githubusercontent.com/u/13755421?v=3","gravatar_id":"","url":"https://api.github.com/users/sarif-standard","html_url":"https://github.com/sarif-standard","followers_url":"https://api.github.com/users/sarif-standard/followers","following_url":"https://api.github.com/users/sarif-standard/following{/other_user}","gists_url":"https://api.github.com/users/sarif-standard/gists{/gist_id}","starred_url":"https://api.github.com/users/sarif-standard/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/sarif-standard/subscriptions","organizations_url":"https://api.github.com/users/sarif-standard/orgs","repos_url":"https://api.github.com/users/sarif-standard/repos","events_url":"https://api.github.com/users/sarif-standard/events{/privacy}","received_events_url":"https://api.github.com/users/sarif-standard/received_events","type":"Organization","site_admin":false},"repo":{"id":40567795,"name":"sarif-spec","full_name":"sarif-standard/sarif-spec","owner":{"login":"sarif-standard","id":13755421,"avatar_url":"https://avatars.githubusercontent.com/u/13755421?v=3","gravatar_id":"","url":"https://api.github.com/users/sarif-standard","html_url":"https://github.com/sarif-standard","followers_url":"https://api.github.com/users/sarif-standard/followers","following_url":"https://api.github.com/users/sarif-standard/following{/other_user}","gists_url":"https://api.github.com/users/sarif-standard/gists{/gist_id}","starred_url":"https://api.github.com/users/sarif-standard/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/sarif-standard/subscriptions","organizations_url":"https://api.github.com/users/sarif-standard/orgs","repos_url":"https://api.github.com/users/sarif-standard/repos","events_url":"https://api.github.com/users/sarif-standard/events{/privacy}","received_events_url":"https://api.github.com/users/sarif-standard/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/sarif-standard/sarif-spec","description":"The specification document for the Static Analysis Results Interchange Format (SARIF)","fork":false,"url":"https://api.github.com/repos/sarif-standard/sarif-spec","forks_url":"https://api.github.com/repos/sarif-standard/sarif-spec/forks","keys_url":"https://api.github.com/repos/sarif-standard/sarif-spec/keys{/key_id}","collaborators_url":"https://api.github.com/repos/sarif-standard/sarif-spec/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/sarif-standard/sarif-spec/teams","hooks_url":"https://api.github.com/repos/sarif-standard/sarif-spec/hooks","issue_events_url":"https://api.github.com/repos/sarif-standard/sarif-spec/issues/events{/number}","events_url":"https://api.github.com/repos/sarif-standard/sarif-spec/events","assignees_url":"https://api.github.com/repos/sarif-standard/sarif-spec/assignees{/user}","branches_url":"https://api.github.com/repos/sarif-standard/sarif-spec/branches{/branch}","tags_url":"https://api.github.com/repos/sarif-standard/sarif-spec/tags","blobs_url":"https://api.github.com/repos/sarif-standard/sarif-spec/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/sarif-standard/sarif-spec/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/sarif-standard/sarif-spec/git/refs{/sha}","trees_url":"https://api.github.com/repos/sarif-standard/sarif-spec/git/trees{/sha}","statuses_url":"https://api.github.com/repos/sarif-standard/sarif-spec/statuses/{sha}","languages_url":"https://api.github.com/repos/sarif-standard/sarif-spec/languages","stargazers_url":"https://api.github.com/repos/sarif-standard/sarif-spec/stargazers","contributors_url":"https://api.github.com/repos/sarif-standard/sarif-spec/contributors","subscribers_url":"https://api.github.com/repos/sarif-standard/sarif-spec/subscribers","subscription_url":"https://api.github.com/repos/sarif-standard/sarif-spec/subscription","commits_url":"https://api.github.com/repos/sarif-standard/sarif-spec/commits{/sha}","git_commits_url":"https://api.github.com/repos/sarif-standard/sarif-spec/git/commits{/sha}","comments_url":"https://api.github.com/repos/sarif-standard/sarif-spec/comments{/number}","issue_comment_url":"https://api.github.com/repos/sarif-standard/sarif-spec/issues/comments{/number}","contents_url":"https://api.github.com/repos/sarif-standard/sarif-spec/contents/{+path}","compare_url":"https://api.github.com/repos/sarif-standard/sarif-spec/compare/{base}...{head}","merges_url":"https://api.github.com/repos/sarif-standard/sarif-spec/merges","archive_url":"https://api.github.com/repos/sarif-standard/sarif-spec/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/sarif-standard/sarif-spec/downloads","issues_url":"https://api.github.com/repos/sarif-standard/sarif-spec/issues{/number}","pulls_url":"https://api.github.com/repos/sarif-standard/sarif-spec/pulls{/number}","milestones_url":"https://api.github.com/repos/sarif-standard/sarif-spec/milestones{/number}","notifications_url":"https://api.github.com/repos/sarif-standard/sarif-spec/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/sarif-standard/sarif-spec/labels{/name}","releases_url":"https://api.github.com/repos/sarif-standard/sarif-spec/releases{/id}","created_at":"2015-08-11T22:14:51Z","updated_at":"2015-11-03T23:57:50Z","pushed_at":"2015-11-29T20:00:53Z","git_url":"git://github.com/sarif-standard/sarif-spec.git","ssh_url":"git@github.com:sarif-standard/sarif-spec.git","clone_url":"https://github.com/sarif-standard/sarif-spec.git","svn_url":"https://github.com/sarif-standard/sarif-spec","homepage":null,"size":388,"stargazers_count":5,"watchers_count":5,"language":"HTML","has_issues":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":2,"mirror_url":null,"open_issues_count":29,"forks":2,"open_issues":29,"watchers":5,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/sarif-standard/sarif-spec/pulls/47"},"html":{"href":"https://github.com/sarif-standard/sarif-spec/pull/47"},"issue":{"href":"https://api.github.com/repos/sarif-standard/sarif-spec/issues/47"},"comments":{"href":"https://api.github.com/repos/sarif-standard/sarif-spec/issues/47/comments"},"review_comments":{"href":"https://api.github.com/repos/sarif-standard/sarif-spec/pulls/47/comments"},"review_comment":{"href":"https://api.github.com/repos/sarif-standard/sarif-spec/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/sarif-standard/sarif-spec/pulls/47/commits"},"statuses":{"href":"https://api.github.com/repos/sarif-standard/sarif-spec/statuses/d66a07d899e56f40f3d00394ac9f2e476ef3ca53"}}}}