{"comment":{"url":"https://api.github.com/repos/sa31fh/ims/comments/16858877","html_url":"https://github.com/sa31fh/ims/commit/3041465e58fecefa8c37a5584c0f933f9229fd9e#commitcomment-16858877","id":16858877,"user":{"login":"sa31fh","id":182206,"avatar_url":"https://avatars.githubusercontent.com/u/182206?v=3","gravatar_id":"","url":"https://api.github.com/users/sa31fh","html_url":"https://github.com/sa31fh","followers_url":"https://api.github.com/users/sa31fh/followers","following_url":"https://api.github.com/users/sa31fh/following{/other_user}","gists_url":"https://api.github.com/users/sa31fh/gists{/gist_id}","starred_url":"https://api.github.com/users/sa31fh/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/sa31fh/subscriptions","organizations_url":"https://api.github.com/users/sa31fh/orgs","repos_url":"https://api.github.com/users/sa31fh/repos","events_url":"https://api.github.com/users/sa31fh/events{/privacy}","received_events_url":"https://api.github.com/users/sa31fh/received_events","type":"User","site_admin":false},"position":11,"line":13,"path":"database/inventory_table.php","commit_id":"3041465e58fecefa8c37a5584c0f933f9229fd9e","created_at":"2016-03-27T21:44:08Z","updated_at":"2016-03-27T21:44:08Z","body":"In case where you are documenting mysqli_result objects being returned, you should also list the keys in each row which will be used to access the data. Otherwise any person not familiar with your function will have to go print the object contents to figure this out -- a sign of documentation which could be enhanced.\r\n\r\nYou don't have to do it right now if that sounds painful, but keep it in mind for the future. A good approach is to update the documentation every time you 'touch' (i.e. change or deal with) a function in future changes you make. That way you'll already know what the function is doing and it breaks the task into trivially small pieces."}}