{"action":"created","issue":{"url":"https://api.github.com/repos/perl6/doc/issues/2334","repository_url":"https://api.github.com/repos/perl6/doc","labels_url":"https://api.github.com/repos/perl6/doc/issues/2334/labels{/name}","comments_url":"https://api.github.com/repos/perl6/doc/issues/2334/comments","events_url":"https://api.github.com/repos/perl6/doc/issues/2334/events","html_url":"https://github.com/perl6/doc/issues/2334","id":364228462,"node_id":"MDU6SXNzdWUzNjQyMjg0NjI=","number":2334,"title":"A booboo and an rfe in contains documentation","user":{"login":"ToddAndMargo","id":843205,"node_id":"MDQ6VXNlcjg0MzIwNQ==","avatar_url":"https://avatars1.githubusercontent.com/u/843205?v=4","gravatar_id":"","url":"https://api.github.com/users/ToddAndMargo","html_url":"https://github.com/ToddAndMargo","followers_url":"https://api.github.com/users/ToddAndMargo/followers","following_url":"https://api.github.com/users/ToddAndMargo/following{/other_user}","gists_url":"https://api.github.com/users/ToddAndMargo/gists{/gist_id}","starred_url":"https://api.github.com/users/ToddAndMargo/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/ToddAndMargo/subscriptions","organizations_url":"https://api.github.com/users/ToddAndMargo/orgs","repos_url":"https://api.github.com/users/ToddAndMargo/repos","events_url":"https://api.github.com/users/ToddAndMargo/events{/privacy}","received_events_url":"https://api.github.com/users/ToddAndMargo/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":0,"created_at":"2018-09-26T21:54:35Z","updated_at":"2018-09-27T04:58:57Z","closed_at":null,"author_association":"NONE","body":"Hi All,\r\n\r\nOver on \r\n    https://docs.perl6.org/routine/contains#(Str)_method_contains\r\nthe return  value is missing: --> Bool\r\n\r\nSince it need to be updated anyway, for clarity, would you please consider the following enhancements:\r\n\r\nOld:           multi method contains(Str:D: Str:D $needle, Int:D $pos)\r\nProposed: multi method contains(Str:D $Haystack : Str:D $Needle, Int:D $Position --> Bool)\r\n\r\nGiving the input string the name \"Haystack\"  gives meaning to the parameter of \"Needle\".  You are searching for the \"needle in the haystack\".  Without this linkage, one is left wondering what the \"needle\" is \"sticking\".\r\n\r\nThe \" :\", rather than \":\" makes it more clear that it is a delimiter to the untrained eye.\r\n\r\nAnd spelling out \"Position\" just makes it clearer what it is.  (Not \"pos\" for Positive or what ever else it can be mistaken for.)\r\n\r\nMany thanks,\r\n-T\r\n\r\n"},"comment":{"url":"https://api.github.com/repos/perl6/doc/issues/comments/424959419","html_url":"https://github.com/perl6/doc/issues/2334#issuecomment-424959419","issue_url":"https://api.github.com/repos/perl6/doc/issues/2334","id":424959419,"node_id":"MDEyOklzc3VlQ29tbWVudDQyNDk1OTQxOQ==","user":{"login":"finanalyst","id":363676,"node_id":"MDQ6VXNlcjM2MzY3Ng==","avatar_url":"https://avatars3.githubusercontent.com/u/363676?v=4","gravatar_id":"","url":"https://api.github.com/users/finanalyst","html_url":"https://github.com/finanalyst","followers_url":"https://api.github.com/users/finanalyst/followers","following_url":"https://api.github.com/users/finanalyst/following{/other_user}","gists_url":"https://api.github.com/users/finanalyst/gists{/gist_id}","starred_url":"https://api.github.com/users/finanalyst/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/finanalyst/subscriptions","organizations_url":"https://api.github.com/users/finanalyst/orgs","repos_url":"https://api.github.com/users/finanalyst/repos","events_url":"https://api.github.com/users/finanalyst/events{/privacy}","received_events_url":"https://api.github.com/users/finanalyst/received_events","type":"User","site_admin":false},"created_at":"2018-09-27T04:58:57Z","updated_at":"2018-09-27T04:58:57Z","author_association":"CONTRIBUTOR","body":"- Adding return type is needed.\r\n- Changing style from lower case to sentence case (eg. $needle -> $Needle) will make this definition stylistically inconsistent with other documentation. I support keeping all variable names lower case.\r\n- surrounding the `:` after the invocant with whitespace to indicate it is different from say `:D` is a fundamental change in style that would affect all documentation. At this point, the marginal benefit seems much less than the hassle of altering it everywhere else. Besides, once a person has understood the pattern, the whitespace becomes irrelevant.\r\n- adding `$haystack` just to remind someone of the idiom seems like overkill. It raises other questions for a `newbie` user, eg. why is it given a special name when it isn't included in the method's calling signature?\r\n- expanding pos -> position. If there is to be change, then why not something more explanatory, such as '$starting-from' ? "}}
{"actor":{"display_login":"finanalyst"}}