{"action":"created","issue":{"url":"https://api.github.com/repos/grantjenks/sorted_containers/issues/24","labels_url":"https://api.github.com/repos/grantjenks/sorted_containers/issues/24/labels{/name}","comments_url":"https://api.github.com/repos/grantjenks/sorted_containers/issues/24/comments","events_url":"https://api.github.com/repos/grantjenks/sorted_containers/issues/24/events","html_url":"https://github.com/grantjenks/sorted_containers/issues/24","id":63795798,"number":24,"title":"Doc issue, clarify key-func arg to SortedDict","user":{"login":"tallforasmurf","id":1137018,"avatar_url":"https://avatars.githubusercontent.com/u/1137018?v=3","gravatar_id":"","url":"https://api.github.com/users/tallforasmurf","html_url":"https://github.com/tallforasmurf","followers_url":"https://api.github.com/users/tallforasmurf/followers","following_url":"https://api.github.com/users/tallforasmurf/following{/other_user}","gists_url":"https://api.github.com/users/tallforasmurf/gists{/gist_id}","starred_url":"https://api.github.com/users/tallforasmurf/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/tallforasmurf/subscriptions","organizations_url":"https://api.github.com/users/tallforasmurf/orgs","repos_url":"https://api.github.com/users/tallforasmurf/repos","events_url":"https://api.github.com/users/tallforasmurf/events{/privacy}","received_events_url":"https://api.github.com/users/tallforasmurf/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"milestone":null,"comments":1,"created_at":"2015-03-23T18:24:00Z","updated_at":"2015-03-23T20:26:56Z","closed_at":null,"body":"In the doc (http://grantjenks.com/docs/sortedcontainers/sorteddict.html) one paragraph documents the optional key argument, but the word \"key\" is used many times for other purposes, and there is no example use of using a key-func.\r\n\r\nFor clarity I recommend using *key_function* for this argument not simply *key*; and including an example. One real-life example would be using a key-func generated by the natsort package to do locale-aware sequencing of the dict but you no doubt can think of others."},"comment":{"url":"https://api.github.com/repos/grantjenks/sorted_containers/issues/comments/85179549","html_url":"https://github.com/grantjenks/sorted_containers/issues/24#issuecomment-85179549","issue_url":"https://api.github.com/repos/grantjenks/sorted_containers/issues/24","id":85179549,"user":{"login":"grantjenks","id":118304,"avatar_url":"https://avatars.githubusercontent.com/u/118304?v=3","gravatar_id":"","url":"https://api.github.com/users/grantjenks","html_url":"https://github.com/grantjenks","followers_url":"https://api.github.com/users/grantjenks/followers","following_url":"https://api.github.com/users/grantjenks/following{/other_user}","gists_url":"https://api.github.com/users/grantjenks/gists{/gist_id}","starred_url":"https://api.github.com/users/grantjenks/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/grantjenks/subscriptions","organizations_url":"https://api.github.com/users/grantjenks/orgs","repos_url":"https://api.github.com/users/grantjenks/repos","events_url":"https://api.github.com/users/grantjenks/events{/privacy}","received_events_url":"https://api.github.com/users/grantjenks/received_events","type":"User","site_admin":false},"created_at":"2015-03-23T20:26:56Z","updated_at":"2015-03-23T20:26:56Z","body":"Good point. I'll update the docs to use *key_function* and add an example in the introduction that uses natural sort or some other."}}