{"action":"closed","issue":{"url":"https://api.github.com/repos/TerraFusion/basicFusion/issues/237","repository_url":"https://api.github.com/repos/TerraFusion/basicFusion","labels_url":"https://api.github.com/repos/TerraFusion/basicFusion/issues/237/labels{/name}","comments_url":"https://api.github.com/repos/TerraFusion/basicFusion/issues/237/comments","events_url":"https://api.github.com/repos/TerraFusion/basicFusion/issues/237/events","html_url":"https://github.com/TerraFusion/basicFusion/issues/237","id":247535192,"number":237,"title":"Documenting Code","user":{"login":"LandonTClipp","id":11232769,"avatar_url":"https://avatars0.githubusercontent.com/u/11232769?v=4","gravatar_id":"","url":"https://api.github.com/users/LandonTClipp","html_url":"https://github.com/LandonTClipp","followers_url":"https://api.github.com/users/LandonTClipp/followers","following_url":"https://api.github.com/users/LandonTClipp/following{/other_user}","gists_url":"https://api.github.com/users/LandonTClipp/gists{/gist_id}","starred_url":"https://api.github.com/users/LandonTClipp/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/LandonTClipp/subscriptions","organizations_url":"https://api.github.com/users/LandonTClipp/orgs","repos_url":"https://api.github.com/users/LandonTClipp/repos","events_url":"https://api.github.com/users/LandonTClipp/events{/privacy}","received_events_url":"https://api.github.com/users/LandonTClipp/received_events","type":"User","site_admin":false},"labels":[{"id":611416403,"url":"https://api.github.com/repos/TerraFusion/basicFusion/labels/Medium%20Priority","name":"Medium Priority","color":"fbca04","default":false},{"id":455028219,"url":"https://api.github.com/repos/TerraFusion/basicFusion/labels/enhancement","name":"enhancement","color":"84b6eb","default":true}],"state":"closed","locked":false,"assignee":{"login":"LandonTClipp","id":11232769,"avatar_url":"https://avatars0.githubusercontent.com/u/11232769?v=4","gravatar_id":"","url":"https://api.github.com/users/LandonTClipp","html_url":"https://github.com/LandonTClipp","followers_url":"https://api.github.com/users/LandonTClipp/followers","following_url":"https://api.github.com/users/LandonTClipp/following{/other_user}","gists_url":"https://api.github.com/users/LandonTClipp/gists{/gist_id}","starred_url":"https://api.github.com/users/LandonTClipp/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/LandonTClipp/subscriptions","organizations_url":"https://api.github.com/users/LandonTClipp/orgs","repos_url":"https://api.github.com/users/LandonTClipp/repos","events_url":"https://api.github.com/users/LandonTClipp/events{/privacy}","received_events_url":"https://api.github.com/users/LandonTClipp/received_events","type":"User","site_admin":false},"assignees":[{"login":"LandonTClipp","id":11232769,"avatar_url":"https://avatars0.githubusercontent.com/u/11232769?v=4","gravatar_id":"","url":"https://api.github.com/users/LandonTClipp","html_url":"https://github.com/LandonTClipp","followers_url":"https://api.github.com/users/LandonTClipp/followers","following_url":"https://api.github.com/users/LandonTClipp/following{/other_user}","gists_url":"https://api.github.com/users/LandonTClipp/gists{/gist_id}","starred_url":"https://api.github.com/users/LandonTClipp/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/LandonTClipp/subscriptions","organizations_url":"https://api.github.com/users/LandonTClipp/orgs","repos_url":"https://api.github.com/users/LandonTClipp/repos","events_url":"https://api.github.com/users/LandonTClipp/events{/privacy}","received_events_url":"https://api.github.com/users/LandonTClipp/received_events","type":"User","site_admin":false},{"login":"richielo","id":13329406,"avatar_url":"https://avatars3.githubusercontent.com/u/13329406?v=4","gravatar_id":"","url":"https://api.github.com/users/richielo","html_url":"https://github.com/richielo","followers_url":"https://api.github.com/users/richielo/followers","following_url":"https://api.github.com/users/richielo/following{/other_user}","gists_url":"https://api.github.com/users/richielo/gists{/gist_id}","starred_url":"https://api.github.com/users/richielo/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/richielo/subscriptions","organizations_url":"https://api.github.com/users/richielo/orgs","repos_url":"https://api.github.com/users/richielo/repos","events_url":"https://api.github.com/users/richielo/events{/privacy}","received_events_url":"https://api.github.com/users/richielo/received_events","type":"User","site_admin":false},{"login":"shashankbansal6","id":17326877,"avatar_url":"https://avatars1.githubusercontent.com/u/17326877?v=4","gravatar_id":"","url":"https://api.github.com/users/shashankbansal6","html_url":"https://github.com/shashankbansal6","followers_url":"https://api.github.com/users/shashankbansal6/followers","following_url":"https://api.github.com/users/shashankbansal6/following{/other_user}","gists_url":"https://api.github.com/users/shashankbansal6/gists{/gist_id}","starred_url":"https://api.github.com/users/shashankbansal6/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/shashankbansal6/subscriptions","organizations_url":"https://api.github.com/users/shashankbansal6/orgs","repos_url":"https://api.github.com/users/shashankbansal6/repos","events_url":"https://api.github.com/users/shashankbansal6/events{/privacy}","received_events_url":"https://api.github.com/users/shashankbansal6/received_events","type":"User","site_admin":false}],"milestone":null,"comments":2,"created_at":"2017-08-02T21:59:29Z","updated_at":"2018-02-12T20:49:16Z","closed_at":"2018-02-12T20:49:16Z","author_association":"OWNER","body":"This will be a sort of \"long-term\" issue that we need to handle. Currently, there are many scripts and programs that are not documented properly. Mainly, code commenting needs to be a priority for us, especially since we will likely not be the only ones to use our code. Please modify all current and future code to comply with the following requirements:\r\n\r\n1. **Comment everything** _very well_. Make sure it is clear what you are attempting to achieve through the comments at every step in your code.\r\n1. **Provide detailed function descriptions** for all of the functions you make. Please refer to libTERRA.c and use the format shown there.\r\n1. **Provide proper program descriptions** that detail what the program does and how to use it. This is the format that must be used:\r\n\r\n```\r\n        [program name]\r\n\r\nUSAGE: [program name] [options]\r\nDESCRIPTION:\r\n        This program.... (note: Always start the description by describing exactly what the program does)\r\nARGUMENTS:\r\n        -a            [Argument description]\r\n        -b            [argument description]\r\netc.\r\n```\r\nThis verbose description should be invoked when the program is run without any arguments. If your program does not take any arguments by default, then the verbose description should be invoked when using the -h flag.\r\n\r\nPlease follow this format as closely as possible."}}
{"actor":{"display_login":"LandonTClipp"}}