{"action":"created","comment":{"url":"https://api.github.com/repos/oss-generic/process/pulls/comments/104385405","pull_request_review_id":25218942,"id":104385405,"diff_hunk":"@@ -138,6 +138,48 @@ e.g. `Error alert email has very long subject #5958`\n > to compensate for GitHub's lack of strong linking between the two.\n > Assume there is an invisible prefix in front of the PR title `Fixes issue : ...`\n \n+## References to code elements\n+\n+Follow these conventions when referring to code elements **from a non-code context** e.g. when referring to a function \n+name from a commit message.\n+\n+> The objective is to be as concise as possible without causing ambiguities. Therefore, omit optional details when\n+> those details are not pertinent to the context.\n+\n+<p>\n+\n+> Refer to the respective coding standards for conventions on how to refer to code elements _from code contexts_ \n+> e.g. when referring to a function from a code comment. \n+\n+### Java\n+\n+* Variables: `package.class#variable` (optional: `package`)\n+\n+  > Examples:\n+  > \n+  > * `seedu.address.data.Person#name`\n+  > * `Person#name`  -- optional parts omitted\n+\n+* Methods: `package.class#method(paramTypes):returnType` (optional: `package`, `:returnType`)","path":"docs/FormatsAndConventions.md","position":26,"original_position":26,"commit_id":"b616e1273efedae1cd092545b9383de4619bd518","original_commit_id":"b616e1273efedae1cd092545b9383de4619bd518","user":{"login":"PierceAndy","id":8639005,"avatar_url":"https://avatars0.githubusercontent.com/u/8639005?v=3","gravatar_id":"","url":"https://api.github.com/users/PierceAndy","html_url":"https://github.com/PierceAndy","followers_url":"https://api.github.com/users/PierceAndy/followers","following_url":"https://api.github.com/users/PierceAndy/following{/other_user}","gists_url":"https://api.github.com/users/PierceAndy/gists{/gist_id}","starred_url":"https://api.github.com/users/PierceAndy/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/PierceAndy/subscriptions","organizations_url":"https://api.github.com/users/PierceAndy/orgs","repos_url":"https://api.github.com/users/PierceAndy/repos","events_url":"https://api.github.com/users/PierceAndy/events{/privacy}","received_events_url":"https://api.github.com/users/PierceAndy/received_events","type":"User","site_admin":false},"body":"Conversely, if `package` then `returnType`, since the punctuation isn't brought up in the rest of the document.","created_at":"2017-03-06T10:40:07Z","updated_at":"2017-03-06T10:47:05Z","html_url":"https://github.com/oss-generic/process/pull/57#discussion_r104385405","pull_request_url":"https://api.github.com/repos/oss-generic/process/pulls/57","_links":{"self":{"href":"https://api.github.com/repos/oss-generic/process/pulls/comments/104385405"},"html":{"href":"https://github.com/oss-generic/process/pull/57#discussion_r104385405"},"pull_request":{"href":"https://api.github.com/repos/oss-generic/process/pulls/57"}}},"pull_request":{"url":"https://api.github.com/repos/oss-generic/process/pulls/57","id":105750882,"html_url":"https://github.com/oss-generic/process/pull/57","diff_url":"https://github.com/oss-generic/process/pull/57.diff","patch_url":"https://github.com/oss-generic/process/pull/57.patch","issue_url":"https://api.github.com/repos/oss-generic/process/issues/57","number":57,"state":"open","locked":false,"title":"Standardize how to refer to Java class variables and methods from text #51","user":{"login":"damithc","id":1673303,"avatar_url":"https://avatars0.githubusercontent.com/u/1673303?v=3","gravatar_id":"","url":"https://api.github.com/users/damithc","html_url":"https://github.com/damithc","followers_url":"https://api.github.com/users/damithc/followers","following_url":"https://api.github.com/users/damithc/following{/other_user}","gists_url":"https://api.github.com/users/damithc/gists{/gist_id}","starred_url":"https://api.github.com/users/damithc/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/damithc/subscriptions","organizations_url":"https://api.github.com/users/damithc/orgs","repos_url":"https://api.github.com/users/damithc/repos","events_url":"https://api.github.com/users/damithc/events{/privacy}","received_events_url":"https://api.github.com/users/damithc/received_events","type":"User","site_admin":false},"body":"Fixes #51 ","created_at":"2017-02-11T11:26:30Z","updated_at":"2017-03-06T10:47:05Z","closed_at":null,"merged_at":null,"merge_commit_sha":"93bbcb92c2a1377ad77b7a2d3e40ce1577ca8167","assignee":null,"assignees":[],"milestone":null,"commits_url":"https://api.github.com/repos/oss-generic/process/pulls/57/commits","review_comments_url":"https://api.github.com/repos/oss-generic/process/pulls/57/comments","review_comment_url":"https://api.github.com/repos/oss-generic/process/pulls/comments{/number}","comments_url":"https://api.github.com/repos/oss-generic/process/issues/57/comments","statuses_url":"https://api.github.com/repos/oss-generic/process/statuses/b616e1273efedae1cd092545b9383de4619bd518","head":{"label":"oss-generic:51-standardize-java-member-references","ref":"51-standardize-java-member-references","sha":"b616e1273efedae1cd092545b9383de4619bd518","user":{"login":"oss-generic","id":20792770,"avatar_url":"https://avatars1.githubusercontent.com/u/20792770?v=3","gravatar_id":"","url":"https://api.github.com/users/oss-generic","html_url":"https://github.com/oss-generic","followers_url":"https://api.github.com/users/oss-generic/followers","following_url":"https://api.github.com/users/oss-generic/following{/other_user}","gists_url":"https://api.github.com/users/oss-generic/gists{/gist_id}","starred_url":"https://api.github.com/users/oss-generic/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/oss-generic/subscriptions","organizations_url":"https://api.github.com/users/oss-generic/orgs","repos_url":"https://api.github.com/users/oss-generic/repos","events_url":"https://api.github.com/users/oss-generic/events{/privacy}","received_events_url":"https://api.github.com/users/oss-generic/received_events","type":"Organization","site_admin":false},"repo":{"id":64748713,"name":"process","full_name":"oss-generic/process","owner":{"login":"oss-generic","id":20792770,"avatar_url":"https://avatars1.githubusercontent.com/u/20792770?v=3","gravatar_id":"","url":"https://api.github.com/users/oss-generic","html_url":"https://github.com/oss-generic","followers_url":"https://api.github.com/users/oss-generic/followers","following_url":"https://api.github.com/users/oss-generic/following{/other_user}","gists_url":"https://api.github.com/users/oss-generic/gists{/gist_id}","starred_url":"https://api.github.com/users/oss-generic/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/oss-generic/subscriptions","organizations_url":"https://api.github.com/users/oss-generic/orgs","repos_url":"https://api.github.com/users/oss-generic/repos","events_url":"https://api.github.com/users/oss-generic/events{/privacy}","received_events_url":"https://api.github.com/users/oss-generic/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/oss-generic/process","description":"The OSS-Generic Reference Process","fork":false,"url":"https://api.github.com/repos/oss-generic/process","forks_url":"https://api.github.com/repos/oss-generic/process/forks","keys_url":"https://api.github.com/repos/oss-generic/process/keys{/key_id}","collaborators_url":"https://api.github.com/repos/oss-generic/process/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/oss-generic/process/teams","hooks_url":"https://api.github.com/repos/oss-generic/process/hooks","issue_events_url":"https://api.github.com/repos/oss-generic/process/issues/events{/number}","events_url":"https://api.github.com/repos/oss-generic/process/events","assignees_url":"https://api.github.com/repos/oss-generic/process/assignees{/user}","branches_url":"https://api.github.com/repos/oss-generic/process/branches{/branch}","tags_url":"https://api.github.com/repos/oss-generic/process/tags","blobs_url":"https://api.github.com/repos/oss-generic/process/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/oss-generic/process/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/oss-generic/process/git/refs{/sha}","trees_url":"https://api.github.com/repos/oss-generic/process/git/trees{/sha}","statuses_url":"https://api.github.com/repos/oss-generic/process/statuses/{sha}","languages_url":"https://api.github.com/repos/oss-generic/process/languages","stargazers_url":"https://api.github.com/repos/oss-generic/process/stargazers","contributors_url":"https://api.github.com/repos/oss-generic/process/contributors","subscribers_url":"https://api.github.com/repos/oss-generic/process/subscribers","subscription_url":"https://api.github.com/repos/oss-generic/process/subscription","commits_url":"https://api.github.com/repos/oss-generic/process/commits{/sha}","git_commits_url":"https://api.github.com/repos/oss-generic/process/git/commits{/sha}","comments_url":"https://api.github.com/repos/oss-generic/process/comments{/number}","issue_comment_url":"https://api.github.com/repos/oss-generic/process/issues/comments{/number}","contents_url":"https://api.github.com/repos/oss-generic/process/contents/{+path}","compare_url":"https://api.github.com/repos/oss-generic/process/compare/{base}...{head}","merges_url":"https://api.github.com/repos/oss-generic/process/merges","archive_url":"https://api.github.com/repos/oss-generic/process/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/oss-generic/process/downloads","issues_url":"https://api.github.com/repos/oss-generic/process/issues{/number}","pulls_url":"https://api.github.com/repos/oss-generic/process/pulls{/number}","milestones_url":"https://api.github.com/repos/oss-generic/process/milestones{/number}","notifications_url":"https://api.github.com/repos/oss-generic/process/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/oss-generic/process/labels{/name}","releases_url":"https://api.github.com/repos/oss-generic/process/releases{/id}","deployments_url":"https://api.github.com/repos/oss-generic/process/deployments","created_at":"2016-08-02T10:44:29Z","updated_at":"2017-01-31T16:04:19Z","pushed_at":"2017-03-05T05:03:12Z","git_url":"git://github.com/oss-generic/process.git","ssh_url":"git@github.com:oss-generic/process.git","clone_url":"https://github.com/oss-generic/process.git","svn_url":"https://github.com/oss-generic/process","homepage":"","size":248,"stargazers_count":2,"watchers_count":2,"language":"CSS","has_issues":true,"has_downloads":true,"has_wiki":true,"has_pages":true,"forks_count":15,"mirror_url":null,"open_issues_count":48,"forks":15,"open_issues":48,"watchers":2,"default_branch":"master"}},"base":{"label":"oss-generic:master","ref":"master","sha":"1b50a73fd8c622e5aa738541a1270321e66b432b","user":{"login":"oss-generic","id":20792770,"avatar_url":"https://avatars1.githubusercontent.com/u/20792770?v=3","gravatar_id":"","url":"https://api.github.com/users/oss-generic","html_url":"https://github.com/oss-generic","followers_url":"https://api.github.com/users/oss-generic/followers","following_url":"https://api.github.com/users/oss-generic/following{/other_user}","gists_url":"https://api.github.com/users/oss-generic/gists{/gist_id}","starred_url":"https://api.github.com/users/oss-generic/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/oss-generic/subscriptions","organizations_url":"https://api.github.com/users/oss-generic/orgs","repos_url":"https://api.github.com/users/oss-generic/repos","events_url":"https://api.github.com/users/oss-generic/events{/privacy}","received_events_url":"https://api.github.com/users/oss-generic/received_events","type":"Organization","site_admin":false},"repo":{"id":64748713,"name":"process","full_name":"oss-generic/process","owner":{"login":"oss-generic","id":20792770,"avatar_url":"https://avatars1.githubusercontent.com/u/20792770?v=3","gravatar_id":"","url":"https://api.github.com/users/oss-generic","html_url":"https://github.com/oss-generic","followers_url":"https://api.github.com/users/oss-generic/followers","following_url":"https://api.github.com/users/oss-generic/following{/other_user}","gists_url":"https://api.github.com/users/oss-generic/gists{/gist_id}","starred_url":"https://api.github.com/users/oss-generic/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/oss-generic/subscriptions","organizations_url":"https://api.github.com/users/oss-generic/orgs","repos_url":"https://api.github.com/users/oss-generic/repos","events_url":"https://api.github.com/users/oss-generic/events{/privacy}","received_events_url":"https://api.github.com/users/oss-generic/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/oss-generic/process","description":"The OSS-Generic Reference Process","fork":false,"url":"https://api.github.com/repos/oss-generic/process","forks_url":"https://api.github.com/repos/oss-generic/process/forks","keys_url":"https://api.github.com/repos/oss-generic/process/keys{/key_id}","collaborators_url":"https://api.github.com/repos/oss-generic/process/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/oss-generic/process/teams","hooks_url":"https://api.github.com/repos/oss-generic/process/hooks","issue_events_url":"https://api.github.com/repos/oss-generic/process/issues/events{/number}","events_url":"https://api.github.com/repos/oss-generic/process/events","assignees_url":"https://api.github.com/repos/oss-generic/process/assignees{/user}","branches_url":"https://api.github.com/repos/oss-generic/process/branches{/branch}","tags_url":"https://api.github.com/repos/oss-generic/process/tags","blobs_url":"https://api.github.com/repos/oss-generic/process/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/oss-generic/process/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/oss-generic/process/git/refs{/sha}","trees_url":"https://api.github.com/repos/oss-generic/process/git/trees{/sha}","statuses_url":"https://api.github.com/repos/oss-generic/process/statuses/{sha}","languages_url":"https://api.github.com/repos/oss-generic/process/languages","stargazers_url":"https://api.github.com/repos/oss-generic/process/stargazers","contributors_url":"https://api.github.com/repos/oss-generic/process/contributors","subscribers_url":"https://api.github.com/repos/oss-generic/process/subscribers","subscription_url":"https://api.github.com/repos/oss-generic/process/subscription","commits_url":"https://api.github.com/repos/oss-generic/process/commits{/sha}","git_commits_url":"https://api.github.com/repos/oss-generic/process/git/commits{/sha}","comments_url":"https://api.github.com/repos/oss-generic/process/comments{/number}","issue_comment_url":"https://api.github.com/repos/oss-generic/process/issues/comments{/number}","contents_url":"https://api.github.com/repos/oss-generic/process/contents/{+path}","compare_url":"https://api.github.com/repos/oss-generic/process/compare/{base}...{head}","merges_url":"https://api.github.com/repos/oss-generic/process/merges","archive_url":"https://api.github.com/repos/oss-generic/process/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/oss-generic/process/downloads","issues_url":"https://api.github.com/repos/oss-generic/process/issues{/number}","pulls_url":"https://api.github.com/repos/oss-generic/process/pulls{/number}","milestones_url":"https://api.github.com/repos/oss-generic/process/milestones{/number}","notifications_url":"https://api.github.com/repos/oss-generic/process/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/oss-generic/process/labels{/name}","releases_url":"https://api.github.com/repos/oss-generic/process/releases{/id}","deployments_url":"https://api.github.com/repos/oss-generic/process/deployments","created_at":"2016-08-02T10:44:29Z","updated_at":"2017-01-31T16:04:19Z","pushed_at":"2017-03-05T05:03:12Z","git_url":"git://github.com/oss-generic/process.git","ssh_url":"git@github.com:oss-generic/process.git","clone_url":"https://github.com/oss-generic/process.git","svn_url":"https://github.com/oss-generic/process","homepage":"","size":248,"stargazers_count":2,"watchers_count":2,"language":"CSS","has_issues":true,"has_downloads":true,"has_wiki":true,"has_pages":true,"forks_count":15,"mirror_url":null,"open_issues_count":48,"forks":15,"open_issues":48,"watchers":2,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/oss-generic/process/pulls/57"},"html":{"href":"https://github.com/oss-generic/process/pull/57"},"issue":{"href":"https://api.github.com/repos/oss-generic/process/issues/57"},"comments":{"href":"https://api.github.com/repos/oss-generic/process/issues/57/comments"},"review_comments":{"href":"https://api.github.com/repos/oss-generic/process/pulls/57/comments"},"review_comment":{"href":"https://api.github.com/repos/oss-generic/process/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/oss-generic/process/pulls/57/commits"},"statuses":{"href":"https://api.github.com/repos/oss-generic/process/statuses/b616e1273efedae1cd092545b9383de4619bd518"}}}}
{"actor":{"display_login":"PierceAndy"}}