{"comment":{"url":"https://api.github.com/repos/ravingrhino/pyjen/comments/10291828","html_url":"https://github.com/ravingrhino/pyjen/commit/6d005d7aaa63c1a576b35154cf99154fd2f89018#commitcomment-10291828","id":10291828,"user":{"login":"TheFriendlyCoder","id":5114350,"avatar_url":"https://avatars.githubusercontent.com/u/5114350?v=3","gravatar_id":"","url":"https://api.github.com/users/TheFriendlyCoder","html_url":"https://github.com/TheFriendlyCoder","followers_url":"https://api.github.com/users/TheFriendlyCoder/followers","following_url":"https://api.github.com/users/TheFriendlyCoder/following{/other_user}","gists_url":"https://api.github.com/users/TheFriendlyCoder/gists{/gist_id}","starred_url":"https://api.github.com/users/TheFriendlyCoder/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/TheFriendlyCoder/subscriptions","organizations_url":"https://api.github.com/users/TheFriendlyCoder/orgs","repos_url":"https://api.github.com/users/TheFriendlyCoder/repos","events_url":"https://api.github.com/users/TheFriendlyCoder/events{/privacy}","received_events_url":"https://api.github.com/users/TheFriendlyCoder/received_events","type":"User","site_admin":false},"position":42,"line":287,"path":"pyjen/view.py","commit_id":"6d005d7aaa63c1a576b35154cf99154fd2f89018","created_at":"2015-03-19T18:24:22Z","updated_at":"2015-03-19T18:24:22Z","body":"I think we should rework these lists of jobs a bit.\r\n\r\nFirst, I suspect the reason you are turning each list as a single string is because your intended use case for this method is to simply return some text data you can embed in a report afterwards. In that case I can understand why you set it up this way. However, it would be more flexible in the general case if you were to return a list of URLs instead. In this way callers have the option of just writing them out verbatim or using them later to construct job objects if they want.\r\n\r\nSecond, typically when I refer to data in the API as a 'job' I typically am referring to objects of type pyjen.job. With that in mind the name of your keys here are non-conforming. If you do just want to return the URLs as they are stored in the view then it'd be better to rename your keys something like \"broken_job_urls\". \r\n\r\nConversely, to stay more inline with this typical convention it may be better to just return 'lightly' constructed job objects in your list instead of just the URLs, then it allows the caller to access any information about those jobs directly without further intervention. Granted, we may need to add a getter for the URL to the job object, but in this context it may provide more benefit to the user here."}}