{"action":"created","issue":{"url":"https://api.github.com/repos/micropython/micropython/issues/1235","labels_url":"https://api.github.com/repos/micropython/micropython/issues/1235/labels{/name}","comments_url":"https://api.github.com/repos/micropython/micropython/issues/1235/comments","events_url":"https://api.github.com/repos/micropython/micropython/issues/1235/events","html_url":"https://github.com/micropython/micropython/issues/1235","id":73770658,"number":1235,"title":"add documentation guidelines to code style guide","user":{"login":"cloudformdesign","id":5587659,"avatar_url":"https://avatars.githubusercontent.com/u/5587659?v=3","gravatar_id":"","url":"https://api.github.com/users/cloudformdesign","html_url":"https://github.com/cloudformdesign","followers_url":"https://api.github.com/users/cloudformdesign/followers","following_url":"https://api.github.com/users/cloudformdesign/following{/other_user}","gists_url":"https://api.github.com/users/cloudformdesign/gists{/gist_id}","starred_url":"https://api.github.com/users/cloudformdesign/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/cloudformdesign/subscriptions","organizations_url":"https://api.github.com/users/cloudformdesign/orgs","repos_url":"https://api.github.com/users/cloudformdesign/repos","events_url":"https://api.github.com/users/cloudformdesign/events{/privacy}","received_events_url":"https://api.github.com/users/cloudformdesign/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"milestone":null,"comments":1,"created_at":"2015-05-06T23:34:35Z","updated_at":"2015-05-07T09:19:34Z","closed_at":null,"body":"From @dpgeorge \r\n\r\n> The standard is implicit in the format of existing comments: be concise, use // prefix, no extra fluff, only write comments for things that are not obvious.\r\n\r\n> In general I'm against lengthy and unnecessary comments, and I don't want to go down the doxygen route. Reading the code should be enough to describe what's happening, and, if it's not, then you write a comment.\r\n\r\n> Most of the comments in this PR go against the above rules. There are some comments that you have that are worth adding but they need trimming and re-formatting.\r\n\r\nThese comments need to be formatted and put in examples in the style guide.\r\n\r\nAlso @dpgeorge, could you add me to the micropython group and set this task to me? If not, I will be completing this anyway."},"comment":{"url":"https://api.github.com/repos/micropython/micropython/issues/comments/99788548","html_url":"https://github.com/micropython/micropython/issues/1235#issuecomment-99788548","issue_url":"https://api.github.com/repos/micropython/micropython/issues/1235","id":99788548,"user":{"login":"dpgeorge","id":6187689,"avatar_url":"https://avatars.githubusercontent.com/u/6187689?v=3","gravatar_id":"","url":"https://api.github.com/users/dpgeorge","html_url":"https://github.com/dpgeorge","followers_url":"https://api.github.com/users/dpgeorge/followers","following_url":"https://api.github.com/users/dpgeorge/following{/other_user}","gists_url":"https://api.github.com/users/dpgeorge/gists{/gist_id}","starred_url":"https://api.github.com/users/dpgeorge/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/dpgeorge/subscriptions","organizations_url":"https://api.github.com/users/dpgeorge/orgs","repos_url":"https://api.github.com/users/dpgeorge/repos","events_url":"https://api.github.com/users/dpgeorge/events{/privacy}","received_events_url":"https://api.github.com/users/dpgeorge/received_events","type":"User","site_admin":false},"created_at":"2015-05-07T09:19:34Z","updated_at":"2015-05-07T09:19:34Z","body":"> could you add me to the micropython group and set this task to me? If not, I will be completing this anyway.\r\n\r\nIt is enough to just say that you want to do it :)"}}