{"action":"created","issue":{"url":"https://api.github.com/repos/Kaggle/kaggle-api/issues/78","repository_url":"https://api.github.com/repos/Kaggle/kaggle-api","labels_url":"https://api.github.com/repos/Kaggle/kaggle-api/issues/78/labels{/name}","comments_url":"https://api.github.com/repos/Kaggle/kaggle-api/issues/78/comments","events_url":"https://api.github.com/repos/Kaggle/kaggle-api/issues/78/events","html_url":"https://github.com/Kaggle/kaggle-api/pull/78","id":348524009,"node_id":"MDExOlB1bGxSZXF1ZXN0MjA2ODU1Mzk1","number":78,"title":"Adding docstrings to functions","user":{"login":"vsoch","id":814322,"node_id":"MDQ6VXNlcjgxNDMyMg==","avatar_url":"https://avatars0.githubusercontent.com/u/814322?v=4","gravatar_id":"","url":"https://api.github.com/users/vsoch","html_url":"https://github.com/vsoch","followers_url":"https://api.github.com/users/vsoch/followers","following_url":"https://api.github.com/users/vsoch/following{/other_user}","gists_url":"https://api.github.com/users/vsoch/gists{/gist_id}","starred_url":"https://api.github.com/users/vsoch/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/vsoch/subscriptions","organizations_url":"https://api.github.com/users/vsoch/orgs","repos_url":"https://api.github.com/users/vsoch/repos","events_url":"https://api.github.com/users/vsoch/events{/privacy}","received_events_url":"https://api.github.com/users/vsoch/received_events","type":"User","site_admin":false},"labels":[],"state":"closed","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":2,"created_at":"2018-08-07T23:39:37Z","updated_at":"2018-08-17T19:53:58Z","closed_at":"2018-08-17T19:50:10Z","author_association":"CONTRIBUTOR","pull_request":{"url":"https://api.github.com/repos/Kaggle/kaggle-api/pulls/78","html_url":"https://github.com/Kaggle/kaggle-api/pull/78","diff_url":"https://github.com/Kaggle/kaggle-api/pull/78.diff","patch_url":"https://github.com/Kaggle/kaggle-api/pull/78.patch"},"body":"This is the first chunk of work (in a work in progress) to add docstrings to functions. I will likely need to go through this a few times, and it will take more than a day or two... will update and remove WIP when ready for review.\r\n\r\n--------------------------------------------------------\r\n## Update\r\n\r\nI've finished the docstrings! I've made sure to do the following:\r\n\r\n - spacing is consistent - I removed extra newlines\r\n - when arguments are repeated for the \"*_cli\" functions, I reference the function being wrapped and only define the new arguments (to avoid definition twice and potential conflict).\r\n - for one function (`initialize_kernel` metadata) there was an argument \"kernel\" that went in, but then wasn't used. I removed it, but if it was defined for a reason please let me know and I'll add it back!\r\n - for a few listings of variables, I made the readability better by putting them in ABC order, each on separate lines.\r\n - for the function `print_config_values` instead of hard coding the separator into the function, I made it an argument with default as `- `. \r\n - the client functions that have the added arguments for \"*_opt\" might need better descriptor, I wasn't totally sure what these were referencing other than some other option for a dataset, kernel, etc. coming from the client that would be used if the kernel / dataset was not defined."},"comment":{"url":"https://api.github.com/repos/Kaggle/kaggle-api/issues/comments/413972065","html_url":"https://github.com/Kaggle/kaggle-api/pull/78#issuecomment-413972065","issue_url":"https://api.github.com/repos/Kaggle/kaggle-api/issues/78","id":413972065,"node_id":"MDEyOklzc3VlQ29tbWVudDQxMzk3MjA2NQ==","user":{"login":"vsoch","id":814322,"node_id":"MDQ6VXNlcjgxNDMyMg==","avatar_url":"https://avatars0.githubusercontent.com/u/814322?v=4","gravatar_id":"","url":"https://api.github.com/users/vsoch","html_url":"https://github.com/vsoch","followers_url":"https://api.github.com/users/vsoch/followers","following_url":"https://api.github.com/users/vsoch/following{/other_user}","gists_url":"https://api.github.com/users/vsoch/gists{/gist_id}","starred_url":"https://api.github.com/users/vsoch/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/vsoch/subscriptions","organizations_url":"https://api.github.com/users/vsoch/orgs","repos_url":"https://api.github.com/users/vsoch/repos","events_url":"https://api.github.com/users/vsoch/events{/privacy}","received_events_url":"https://api.github.com/users/vsoch/received_events","type":"User","site_admin":false},"created_at":"2018-08-17T19:53:58Z","updated_at":"2018-08-17T19:53:58Z","author_association":"CONTRIBUTOR","body":"Yeah, completely understand the \"janky stuff\" workarounds.\r\n\r\nThanks @rysteboe ! Let me know what else I can help with whenever :) "}}
{"actor":{"display_login":"vsoch"}}