{"action":"created","issue":{"url":"https://api.github.com/repos/ServiceManager/ServiceManager/issues/26","labels_url":"https://api.github.com/repos/ServiceManager/ServiceManager/issues/26/labels{/name}","comments_url":"https://api.github.com/repos/ServiceManager/ServiceManager/issues/26/comments","events_url":"https://api.github.com/repos/ServiceManager/ServiceManager/issues/26/events","html_url":"https://github.com/ServiceManager/ServiceManager/issues/26","id":106900833,"number":26,"title":"Documenting functions and return codes","user":{"login":"mkfifo","id":75518,"avatar_url":"https://avatars.githubusercontent.com/u/75518?v=3","gravatar_id":"","url":"https://api.github.com/users/mkfifo","html_url":"https://github.com/mkfifo","followers_url":"https://api.github.com/users/mkfifo/followers","following_url":"https://api.github.com/users/mkfifo/following{/other_user}","gists_url":"https://api.github.com/users/mkfifo/gists{/gist_id}","starred_url":"https://api.github.com/users/mkfifo/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/mkfifo/subscriptions","organizations_url":"https://api.github.com/users/mkfifo/orgs","repos_url":"https://api.github.com/users/mkfifo/repos","events_url":"https://api.github.com/users/mkfifo/events{/privacy}","received_events_url":"https://api.github.com/users/mkfifo/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"milestone":null,"comments":5,"created_at":"2015-09-17T02:40:20Z","updated_at":"2015-09-17T23:14:49Z","closed_at":null,"body":"I think it would be helpful to document above each function (especially in headers), documentation could include:\r\n* what the function does\r\n* the return code for success\r\n* the return code for failure\r\n\r\nWould you be happy with such documentation?\r\n\r\nI was also wondering on this project's error code policy, is `0` used in all cases for an error?"},"comment":{"url":"https://api.github.com/repos/ServiceManager/ServiceManager/issues/comments/141267147","html_url":"https://github.com/ServiceManager/ServiceManager/issues/26#issuecomment-141267147","issue_url":"https://api.github.com/repos/ServiceManager/ServiceManager/issues/26","id":141267147,"user":{"login":"mkfifo","id":75518,"avatar_url":"https://avatars.githubusercontent.com/u/75518?v=3","gravatar_id":"","url":"https://api.github.com/users/mkfifo","html_url":"https://github.com/mkfifo","followers_url":"https://api.github.com/users/mkfifo/followers","following_url":"https://api.github.com/users/mkfifo/following{/other_user}","gists_url":"https://api.github.com/users/mkfifo/gists{/gist_id}","starred_url":"https://api.github.com/users/mkfifo/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/mkfifo/subscriptions","organizations_url":"https://api.github.com/users/mkfifo/orgs","repos_url":"https://api.github.com/users/mkfifo/repos","events_url":"https://api.github.com/users/mkfifo/events{/privacy}","received_events_url":"https://api.github.com/users/mkfifo/received_events","type":"User","site_admin":false},"created_at":"2015-09-17T23:14:49Z","updated_at":"2015-09-17T23:14:49Z","body":"@JX7P FWIW I think literate programming is an interesting idea, but I do agree that the tooling isn't really there for it. Little things like syntax highlighting in vim (along with syntax checking plugins like syntastic) just don't behave nicely."}}