{"action":"created","comment":{"url":"https://api.github.com/repos/dlang-community/D-Scanner/pulls/comments/177764835","pull_request_review_id":107696900,"id":177764835,"diff_hunk":"@@ -187,36 +187,81 @@ private:\n \t\treturn comment;\n \t}\n \n-\tvoid checkDdocParams(size_t line, size_t column, const Parameters params)\n+\tvoid checkDdocParams(size_t line, size_t column, const Parameters params,\n+\t\t\t\t\t     const TemplateParameters templateParameters = null)\n \t{\n-\t\timport std.algorithm.searching : canFind;\n+\t\timport std.array : array;\n+\t\timport std.algorithm.searching : canFind, countUntil;\n+\t\timport std.algorithm.iteration : map;\n+\t\timport std.algorithm.mutation : remove;\n+\t\timport std.range : indexed, iota;\n+\n+\t\t// convert templateParameters into a string[] for faster access\n+\t\tconst(TemplateParameter)[] templateList;\n+\t\tif (const tp = templateParameters)","path":"src/dscanner/analysis/properly_documented_public_functions.d","position":28,"original_position":28,"commit_id":"06bc5323b70d3c88398d52597b5b5f539243afd1","original_commit_id":"8078409048170b0c5d8f469fe90c0fd9d68d2398","user":{"login":"wilzbach","id":4370550,"avatar_url":"https://avatars3.githubusercontent.com/u/4370550?v=4","gravatar_id":"","url":"https://api.github.com/users/wilzbach","html_url":"https://github.com/wilzbach","followers_url":"https://api.github.com/users/wilzbach/followers","following_url":"https://api.github.com/users/wilzbach/following{/other_user}","gists_url":"https://api.github.com/users/wilzbach/gists{/gist_id}","starred_url":"https://api.github.com/users/wilzbach/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/wilzbach/subscriptions","organizations_url":"https://api.github.com/users/wilzbach/orgs","repos_url":"https://api.github.com/users/wilzbach/repos","events_url":"https://api.github.com/users/wilzbach/events{/privacy}","received_events_url":"https://api.github.com/users/wilzbach/received_events","type":"User","site_admin":false},"body":"it would then be \r\n\r\n```\r\nif (templateParameters && templateParameters.templateParameterList)\r\n    templateList = templateParameters.templateParameterList.items;\r\n```\r\n\r\nimho not much nicer.","created_at":"2018-03-28T14:16:59Z","updated_at":"2018-03-28T14:16:59Z","html_url":"https://github.com/dlang-community/D-Scanner/pull/574#discussion_r177764835","pull_request_url":"https://api.github.com/repos/dlang-community/D-Scanner/pulls/574","author_association":"OWNER","_links":{"self":{"href":"https://api.github.com/repos/dlang-community/D-Scanner/pulls/comments/177764835"},"html":{"href":"https://github.com/dlang-community/D-Scanner/pull/574#discussion_r177764835"},"pull_request":{"href":"https://api.github.com/repos/dlang-community/D-Scanner/pulls/574"}},"in_reply_to_id":177698288},"pull_request":{"url":"https://api.github.com/repos/dlang-community/D-Scanner/pulls/574","id":177965723,"html_url":"https://github.com/dlang-community/D-Scanner/pull/574","diff_url":"https://github.com/dlang-community/D-Scanner/pull/574.diff","patch_url":"https://github.com/dlang-community/D-Scanner/pull/574.patch","issue_url":"https://api.github.com/repos/dlang-community/D-Scanner/issues/574","number":574,"state":"open","locked":false,"title":"Don't force the documentation of the template parameter if it's a used type in the parameter list","user":{"login":"wilzbach","id":4370550,"avatar_url":"https://avatars3.githubusercontent.com/u/4370550?v=4","gravatar_id":"","url":"https://api.github.com/users/wilzbach","html_url":"https://github.com/wilzbach","followers_url":"https://api.github.com/users/wilzbach/followers","following_url":"https://api.github.com/users/wilzbach/following{/other_user}","gists_url":"https://api.github.com/users/wilzbach/gists{/gist_id}","starred_url":"https://api.github.com/users/wilzbach/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/wilzbach/subscriptions","organizations_url":"https://api.github.com/users/wilzbach/orgs","repos_url":"https://api.github.com/users/wilzbach/repos","events_url":"https://api.github.com/users/wilzbach/events{/privacy}","received_events_url":"https://api.github.com/users/wilzbach/received_events","type":"User","site_admin":false},"body":"This relaxes the proper documentation checker to avoid enforcing the documentation of template parameters that are used as parameter types.\r\nFor example:\r\n\r\n```\r\n/++\r\nAn awesome description.\r\n\r\nParams:\r\n\tr =  an input range.\r\n\r\nReturns: Awesome values.\r\n+/\r\nstring bar(R)(R r){}\r\n```\r\n\r\nThe documentation of `R` isn't necessary here.\r\nHowever, the following will trigger a warning about the missing documentation of `U`:\r\n\r\n```\r\n/++\r\nAn awesome description.\r\n\r\nParams:\r\n\tr =  an input range.\r\n\r\nReturns: Awesome values.\r\n+/\r\nstring bar(U, R)(R r){}\r\n```\r\n\r\nCC @JackStouffer","created_at":"2018-03-28T08:37:21Z","updated_at":"2018-03-28T14:16:59Z","closed_at":null,"merged_at":null,"merge_commit_sha":"2a6946004d685811168504d61dbbb4a261f447db","assignee":null,"assignees":[],"requested_reviewers":[],"requested_teams":[],"labels":[],"milestone":{"url":"https://api.github.com/repos/dlang-community/D-Scanner/milestones/6","html_url":"https://github.com/dlang-community/D-Scanner/milestone/6","labels_url":"https://api.github.com/repos/dlang-community/D-Scanner/milestones/6/labels","id":2066691,"number":6,"title":"0.5.0","description":"","creator":{"login":"Hackerpilot","id":1657783,"avatar_url":"https://avatars1.githubusercontent.com/u/1657783?v=4","gravatar_id":"","url":"https://api.github.com/users/Hackerpilot","html_url":"https://github.com/Hackerpilot","followers_url":"https://api.github.com/users/Hackerpilot/followers","following_url":"https://api.github.com/users/Hackerpilot/following{/other_user}","gists_url":"https://api.github.com/users/Hackerpilot/gists{/gist_id}","starred_url":"https://api.github.com/users/Hackerpilot/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/Hackerpilot/subscriptions","organizations_url":"https://api.github.com/users/Hackerpilot/orgs","repos_url":"https://api.github.com/users/Hackerpilot/repos","events_url":"https://api.github.com/users/Hackerpilot/events{/privacy}","received_events_url":"https://api.github.com/users/Hackerpilot/received_events","type":"User","site_admin":false},"open_issues":1,"closed_issues":14,"state":"open","created_at":"2016-10-13T02:32:41Z","updated_at":"2018-03-28T09:40:53Z","due_on":"2018-03-26T07:00:00Z","closed_at":null},"commits_url":"https://api.github.com/repos/dlang-community/D-Scanner/pulls/574/commits","review_comments_url":"https://api.github.com/repos/dlang-community/D-Scanner/pulls/574/comments","review_comment_url":"https://api.github.com/repos/dlang-community/D-Scanner/pulls/comments{/number}","comments_url":"https://api.github.com/repos/dlang-community/D-Scanner/issues/574/comments","statuses_url":"https://api.github.com/repos/dlang-community/D-Scanner/statuses/06bc5323b70d3c88398d52597b5b5f539243afd1","head":{"label":"wilzbach:documented-relax","ref":"documented-relax","sha":"06bc5323b70d3c88398d52597b5b5f539243afd1","user":{"login":"wilzbach","id":4370550,"avatar_url":"https://avatars3.githubusercontent.com/u/4370550?v=4","gravatar_id":"","url":"https://api.github.com/users/wilzbach","html_url":"https://github.com/wilzbach","followers_url":"https://api.github.com/users/wilzbach/followers","following_url":"https://api.github.com/users/wilzbach/following{/other_user}","gists_url":"https://api.github.com/users/wilzbach/gists{/gist_id}","starred_url":"https://api.github.com/users/wilzbach/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/wilzbach/subscriptions","organizations_url":"https://api.github.com/users/wilzbach/orgs","repos_url":"https://api.github.com/users/wilzbach/repos","events_url":"https://api.github.com/users/wilzbach/events{/privacy}","received_events_url":"https://api.github.com/users/wilzbach/received_events","type":"User","site_admin":false},"repo":{"id":56204481,"name":"Dscanner","full_name":"wilzbach/Dscanner","owner":{"login":"wilzbach","id":4370550,"avatar_url":"https://avatars3.githubusercontent.com/u/4370550?v=4","gravatar_id":"","url":"https://api.github.com/users/wilzbach","html_url":"https://github.com/wilzbach","followers_url":"https://api.github.com/users/wilzbach/followers","following_url":"https://api.github.com/users/wilzbach/following{/other_user}","gists_url":"https://api.github.com/users/wilzbach/gists{/gist_id}","starred_url":"https://api.github.com/users/wilzbach/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/wilzbach/subscriptions","organizations_url":"https://api.github.com/users/wilzbach/orgs","repos_url":"https://api.github.com/users/wilzbach/repos","events_url":"https://api.github.com/users/wilzbach/events{/privacy}","received_events_url":"https://api.github.com/users/wilzbach/received_events","type":"User","site_admin":false},"private":false,"html_url":"https://github.com/wilzbach/Dscanner","description":"Swiss-army knife for D source code","fork":true,"url":"https://api.github.com/repos/wilzbach/Dscanner","forks_url":"https://api.github.com/repos/wilzbach/Dscanner/forks","keys_url":"https://api.github.com/repos/wilzbach/Dscanner/keys{/key_id}","collaborators_url":"https://api.github.com/repos/wilzbach/Dscanner/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/wilzbach/Dscanner/teams","hooks_url":"https://api.github.com/repos/wilzbach/Dscanner/hooks","issue_events_url":"https://api.github.com/repos/wilzbach/Dscanner/issues/events{/number}","events_url":"https://api.github.com/repos/wilzbach/Dscanner/events","assignees_url":"https://api.github.com/repos/wilzbach/Dscanner/assignees{/user}","branches_url":"https://api.github.com/repos/wilzbach/Dscanner/branches{/branch}","tags_url":"https://api.github.com/repos/wilzbach/Dscanner/tags","blobs_url":"https://api.github.com/repos/wilzbach/Dscanner/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/wilzbach/Dscanner/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/wilzbach/Dscanner/git/refs{/sha}","trees_url":"https://api.github.com/repos/wilzbach/Dscanner/git/trees{/sha}","statuses_url":"https://api.github.com/repos/wilzbach/Dscanner/statuses/{sha}","languages_url":"https://api.github.com/repos/wilzbach/Dscanner/languages","stargazers_url":"https://api.github.com/repos/wilzbach/Dscanner/stargazers","contributors_url":"https://api.github.com/repos/wilzbach/Dscanner/contributors","subscribers_url":"https://api.github.com/repos/wilzbach/Dscanner/subscribers","subscription_url":"https://api.github.com/repos/wilzbach/Dscanner/subscription","commits_url":"https://api.github.com/repos/wilzbach/Dscanner/commits{/sha}","git_commits_url":"https://api.github.com/repos/wilzbach/Dscanner/git/commits{/sha}","comments_url":"https://api.github.com/repos/wilzbach/Dscanner/comments{/number}","issue_comment_url":"https://api.github.com/repos/wilzbach/Dscanner/issues/comments{/number}","contents_url":"https://api.github.com/repos/wilzbach/Dscanner/contents/{+path}","compare_url":"https://api.github.com/repos/wilzbach/Dscanner/compare/{base}...{head}","merges_url":"https://api.github.com/repos/wilzbach/Dscanner/merges","archive_url":"https://api.github.com/repos/wilzbach/Dscanner/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/wilzbach/Dscanner/downloads","issues_url":"https://api.github.com/repos/wilzbach/Dscanner/issues{/number}","pulls_url":"https://api.github.com/repos/wilzbach/Dscanner/pulls{/number}","milestones_url":"https://api.github.com/repos/wilzbach/Dscanner/milestones{/number}","notifications_url":"https://api.github.com/repos/wilzbach/Dscanner/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/wilzbach/Dscanner/labels{/name}","releases_url":"https://api.github.com/repos/wilzbach/Dscanner/releases{/id}","deployments_url":"https://api.github.com/repos/wilzbach/Dscanner/deployments","created_at":"2016-04-14T03:29:55Z","updated_at":"2018-03-28T07:16:13Z","pushed_at":"2018-03-28T14:12:46Z","git_url":"git://github.com/wilzbach/Dscanner.git","ssh_url":"git@github.com:wilzbach/Dscanner.git","clone_url":"https://github.com/wilzbach/Dscanner.git","svn_url":"https://github.com/wilzbach/Dscanner","homepage":null,"size":3628,"stargazers_count":2,"watchers_count":2,"language":"D","has_issues":false,"has_projects":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":0,"mirror_url":null,"archived":false,"open_issues_count":0,"license":{"key":"bsl-1.0","name":"Boost Software License 1.0","spdx_id":"BSL-1.0","url":"https://api.github.com/licenses/bsl-1.0"},"forks":0,"open_issues":0,"watchers":2,"default_branch":"master"}},"base":{"label":"dlang-community:master","ref":"master","sha":"847782d6893e709043fb407618a88592b874b727","user":{"login":"dlang-community","id":24511724,"avatar_url":"https://avatars1.githubusercontent.com/u/24511724?v=4","gravatar_id":"","url":"https://api.github.com/users/dlang-community","html_url":"https://github.com/dlang-community","followers_url":"https://api.github.com/users/dlang-community/followers","following_url":"https://api.github.com/users/dlang-community/following{/other_user}","gists_url":"https://api.github.com/users/dlang-community/gists{/gist_id}","starred_url":"https://api.github.com/users/dlang-community/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/dlang-community/subscriptions","organizations_url":"https://api.github.com/users/dlang-community/orgs","repos_url":"https://api.github.com/users/dlang-community/repos","events_url":"https://api.github.com/users/dlang-community/events{/privacy}","received_events_url":"https://api.github.com/users/dlang-community/received_events","type":"Organization","site_admin":false},"repo":{"id":4096145,"name":"D-Scanner","full_name":"dlang-community/D-Scanner","owner":{"login":"dlang-community","id":24511724,"avatar_url":"https://avatars1.githubusercontent.com/u/24511724?v=4","gravatar_id":"","url":"https://api.github.com/users/dlang-community","html_url":"https://github.com/dlang-community","followers_url":"https://api.github.com/users/dlang-community/followers","following_url":"https://api.github.com/users/dlang-community/following{/other_user}","gists_url":"https://api.github.com/users/dlang-community/gists{/gist_id}","starred_url":"https://api.github.com/users/dlang-community/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/dlang-community/subscriptions","organizations_url":"https://api.github.com/users/dlang-community/orgs","repos_url":"https://api.github.com/users/dlang-community/repos","events_url":"https://api.github.com/users/dlang-community/events{/privacy}","received_events_url":"https://api.github.com/users/dlang-community/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/dlang-community/D-Scanner","description":"Swiss-army knife for D source code","fork":false,"url":"https://api.github.com/repos/dlang-community/D-Scanner","forks_url":"https://api.github.com/repos/dlang-community/D-Scanner/forks","keys_url":"https://api.github.com/repos/dlang-community/D-Scanner/keys{/key_id}","collaborators_url":"https://api.github.com/repos/dlang-community/D-Scanner/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/dlang-community/D-Scanner/teams","hooks_url":"https://api.github.com/repos/dlang-community/D-Scanner/hooks","issue_events_url":"https://api.github.com/repos/dlang-community/D-Scanner/issues/events{/number}","events_url":"https://api.github.com/repos/dlang-community/D-Scanner/events","assignees_url":"https://api.github.com/repos/dlang-community/D-Scanner/assignees{/user}","branches_url":"https://api.github.com/repos/dlang-community/D-Scanner/branches{/branch}","tags_url":"https://api.github.com/repos/dlang-community/D-Scanner/tags","blobs_url":"https://api.github.com/repos/dlang-community/D-Scanner/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/dlang-community/D-Scanner/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/dlang-community/D-Scanner/git/refs{/sha}","trees_url":"https://api.github.com/repos/dlang-community/D-Scanner/git/trees{/sha}","statuses_url":"https://api.github.com/repos/dlang-community/D-Scanner/statuses/{sha}","languages_url":"https://api.github.com/repos/dlang-community/D-Scanner/languages","stargazers_url":"https://api.github.com/repos/dlang-community/D-Scanner/stargazers","contributors_url":"https://api.github.com/repos/dlang-community/D-Scanner/contributors","subscribers_url":"https://api.github.com/repos/dlang-community/D-Scanner/subscribers","subscription_url":"https://api.github.com/repos/dlang-community/D-Scanner/subscription","commits_url":"https://api.github.com/repos/dlang-community/D-Scanner/commits{/sha}","git_commits_url":"https://api.github.com/repos/dlang-community/D-Scanner/git/commits{/sha}","comments_url":"https://api.github.com/repos/dlang-community/D-Scanner/comments{/number}","issue_comment_url":"https://api.github.com/repos/dlang-community/D-Scanner/issues/comments{/number}","contents_url":"https://api.github.com/repos/dlang-community/D-Scanner/contents/{+path}","compare_url":"https://api.github.com/repos/dlang-community/D-Scanner/compare/{base}...{head}","merges_url":"https://api.github.com/repos/dlang-community/D-Scanner/merges","archive_url":"https://api.github.com/repos/dlang-community/D-Scanner/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/dlang-community/D-Scanner/downloads","issues_url":"https://api.github.com/repos/dlang-community/D-Scanner/issues{/number}","pulls_url":"https://api.github.com/repos/dlang-community/D-Scanner/pulls{/number}","milestones_url":"https://api.github.com/repos/dlang-community/D-Scanner/milestones{/number}","notifications_url":"https://api.github.com/repos/dlang-community/D-Scanner/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/dlang-community/D-Scanner/labels{/name}","releases_url":"https://api.github.com/repos/dlang-community/D-Scanner/releases{/id}","deployments_url":"https://api.github.com/repos/dlang-community/D-Scanner/deployments","created_at":"2012-04-21T13:04:35Z","updated_at":"2018-03-27T13:24:11Z","pushed_at":"2018-03-28T14:12:48Z","git_url":"git://github.com/dlang-community/D-Scanner.git","ssh_url":"git@github.com:dlang-community/D-Scanner.git","clone_url":"https://github.com/dlang-community/D-Scanner.git","svn_url":"https://github.com/dlang-community/D-Scanner","homepage":null,"size":3616,"stargazers_count":162,"watchers_count":162,"language":"D","has_issues":true,"has_projects":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":59,"mirror_url":null,"archived":false,"open_issues_count":72,"license":{"key":"bsl-1.0","name":"Boost Software License 1.0","spdx_id":"BSL-1.0","url":"https://api.github.com/licenses/bsl-1.0"},"forks":59,"open_issues":72,"watchers":162,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/dlang-community/D-Scanner/pulls/574"},"html":{"href":"https://github.com/dlang-community/D-Scanner/pull/574"},"issue":{"href":"https://api.github.com/repos/dlang-community/D-Scanner/issues/574"},"comments":{"href":"https://api.github.com/repos/dlang-community/D-Scanner/issues/574/comments"},"review_comments":{"href":"https://api.github.com/repos/dlang-community/D-Scanner/pulls/574/comments"},"review_comment":{"href":"https://api.github.com/repos/dlang-community/D-Scanner/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/dlang-community/D-Scanner/pulls/574/commits"},"statuses":{"href":"https://api.github.com/repos/dlang-community/D-Scanner/statuses/06bc5323b70d3c88398d52597b5b5f539243afd1"}},"author_association":"OWNER"}}
{"actor":{"display_login":"wilzbach"}}