{"action":"created","issue":{"url":"https://api.github.com/repos/golang/go/issues/10909","labels_url":"https://api.github.com/repos/golang/go/issues/10909/labels{/name}","comments_url":"https://api.github.com/repos/golang/go/issues/10909/comments","events_url":"https://api.github.com/repos/golang/go/issues/10909/events","html_url":"https://github.com/golang/go/issues/10909","id":77940411,"number":10909,"title":"doc: document the \"Deprecated\" convention","user":{"login":"minux","id":135652,"avatar_url":"https://avatars.githubusercontent.com/u/135652?v=3","gravatar_id":"","url":"https://api.github.com/users/minux","html_url":"https://github.com/minux","followers_url":"https://api.github.com/users/minux/followers","following_url":"https://api.github.com/users/minux/following{/other_user}","gists_url":"https://api.github.com/users/minux/gists{/gist_id}","starred_url":"https://api.github.com/users/minux/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/minux/subscriptions","organizations_url":"https://api.github.com/users/minux/orgs","repos_url":"https://api.github.com/users/minux/repos","events_url":"https://api.github.com/users/minux/events{/privacy}","received_events_url":"https://api.github.com/users/minux/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"milestone":{"url":"https://api.github.com/repos/golang/go/milestones/24","html_url":"https://github.com/golang/go/milestones/Go1.6","labels_url":"https://api.github.com/repos/golang/go/milestones/24/labels","id":1096159,"number":24,"title":"Go1.6","description":"","creator":{"login":"josharian","id":67496,"avatar_url":"https://avatars.githubusercontent.com/u/67496?v=3","gravatar_id":"","url":"https://api.github.com/users/josharian","html_url":"https://github.com/josharian","followers_url":"https://api.github.com/users/josharian/followers","following_url":"https://api.github.com/users/josharian/following{/other_user}","gists_url":"https://api.github.com/users/josharian/gists{/gist_id}","starred_url":"https://api.github.com/users/josharian/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/josharian/subscriptions","organizations_url":"https://api.github.com/users/josharian/orgs","repos_url":"https://api.github.com/users/josharian/repos","events_url":"https://api.github.com/users/josharian/events{/privacy}","received_events_url":"https://api.github.com/users/josharian/received_events","type":"User","site_admin":false},"open_issues":328,"closed_issues":182,"state":"open","created_at":"2015-05-05T02:39:06Z","updated_at":"2015-10-11T22:46:38Z","due_on":"2016-01-31T08:00:00Z","closed_at":null},"comments":10,"created_at":"2015-05-19T05:26:01Z","updated_at":"2015-10-12T01:00:19Z","closed_at":null,"body":"Perhaps in effective go. Also worth mention in go1.5.html?\r\n\r\nsee https://groups.google.com/forum/#!topic/golang-dev/ya5vE0G62Z4."},"comment":{"url":"https://api.github.com/repos/golang/go/issues/comments/147267897","html_url":"https://github.com/golang/go/issues/10909#issuecomment-147267897","issue_url":"https://api.github.com/repos/golang/go/issues/10909","id":147267897,"user":{"login":"shurcooL","id":1924134,"avatar_url":"https://avatars.githubusercontent.com/u/1924134?v=3","gravatar_id":"","url":"https://api.github.com/users/shurcooL","html_url":"https://github.com/shurcooL","followers_url":"https://api.github.com/users/shurcooL/followers","following_url":"https://api.github.com/users/shurcooL/following{/other_user}","gists_url":"https://api.github.com/users/shurcooL/gists{/gist_id}","starred_url":"https://api.github.com/users/shurcooL/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/shurcooL/subscriptions","organizations_url":"https://api.github.com/users/shurcooL/orgs","repos_url":"https://api.github.com/users/shurcooL/repos","events_url":"https://api.github.com/users/shurcooL/events{/privacy}","received_events_url":"https://api.github.com/users/shurcooL/received_events","type":"User","site_admin":false},"created_at":"2015-10-12T01:00:19Z","updated_at":"2015-10-12T01:00:19Z","body":"> With the current scheme, it's nice that the reason for the deprecation appears\r\nafter \"Deprecated:\".\r\n\r\nI agree, that should be preserved. The way I imagined it would be:\r\n\r\n```Go\r\n// Deprecated: Use SlicePtrFromStrings instead.\r\n//\r\n// StringSlicePtr converts a slice of strings to a slice of pointers\r\n// to NUL-terminated byte arrays. If any string contains a NUL byte\r\n// this function panics instead of returning an error.\r\nfunc StringSlicePtr(ss []string) []*byte {\r\n```\r\n\r\n> I don't really like the idea of putting the word \"Deprecated\" first.\r\n\r\nDo you still dislike it even given what I've mentioned above? If so, that's completely okay. I just wanted to mention this so that it would be considered.\r\n\r\n> But perhaps godoc should be made to hide or collapse the definitions of\r\ndeprecated functions, and to highlight the word \"Deprecated\" in bold and/or\r\nred.\r\n\r\nPerhaps it (and many other Go editors/tools) can/should do that. But I think that's an orthogonal optional enhancement.\r\n\r\nI realize requiring \"Deprecated:\" to come first will require an update to `golint` which currently checks that comments begin with \"// {{.IdenitiferName}} ...\"."}}