{"action":"created","comment":{"url":"https://api.github.com/repos/gammapy/gammapy/pulls/comments/36039921","id":36039921,"diff_hunk":"@@ -561,12 +539,12 @@ def find_energy_bin(self, energy):\n \n         Parameters\n         ----------\n-        energy : `~numpy.array`\n+        energy : `~numpy.ndarray`","path":"gammapy/background/models.py","position":118,"original_position":118,"commit_id":"543505a2bb59eae7195354b2a384bdb889bb3648","original_commit_id":"543505a2bb59eae7195354b2a384bdb889bb3648","user":{"login":"mapazarr","id":11326731,"avatar_url":"https://avatars.githubusercontent.com/u/11326731?v=3","gravatar_id":"","url":"https://api.github.com/users/mapazarr","html_url":"https://github.com/mapazarr","followers_url":"https://api.github.com/users/mapazarr/followers","following_url":"https://api.github.com/users/mapazarr/following{/other_user}","gists_url":"https://api.github.com/users/mapazarr/gists{/gist_id}","starred_url":"https://api.github.com/users/mapazarr/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/mapazarr/subscriptions","organizations_url":"https://api.github.com/users/mapazarr/orgs","repos_url":"https://api.github.com/users/mapazarr/repos","events_url":"https://api.github.com/users/mapazarr/events{/privacy}","received_events_url":"https://api.github.com/users/mapazarr/received_events","type":"User","site_admin":false},"body":"Done.","created_at":"2015-08-02T06:06:48Z","updated_at":"2015-08-02T06:06:48Z","html_url":"https://github.com/gammapy/gammapy/pull/301#discussion_r36039921","pull_request_url":"https://api.github.com/repos/gammapy/gammapy/pulls/301","_links":{"self":{"href":"https://api.github.com/repos/gammapy/gammapy/pulls/comments/36039921"},"html":{"href":"https://github.com/gammapy/gammapy/pull/301#discussion_r36039921"},"pull_request":{"href":"https://api.github.com/repos/gammapy/gammapy/pulls/301"}}},"pull_request":{"url":"https://api.github.com/repos/gammapy/gammapy/pulls/301","id":40645109,"html_url":"https://github.com/gammapy/gammapy/pull/301","diff_url":"https://github.com/gammapy/gammapy/pull/301.diff","patch_url":"https://github.com/gammapy/gammapy/pull/301.patch","issue_url":"https://api.github.com/repos/gammapy/gammapy/issues/301","number":301,"state":"open","locked":false,"title":"Simplified attribute docstrings","user":{"login":"mapazarr","id":11326731,"avatar_url":"https://avatars.githubusercontent.com/u/11326731?v=3","gravatar_id":"","url":"https://api.github.com/users/mapazarr","html_url":"https://github.com/mapazarr","followers_url":"https://api.github.com/users/mapazarr/followers","following_url":"https://api.github.com/users/mapazarr/following{/other_user}","gists_url":"https://api.github.com/users/mapazarr/gists{/gist_id}","starred_url":"https://api.github.com/users/mapazarr/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/mapazarr/subscriptions","organizations_url":"https://api.github.com/users/mapazarr/orgs","repos_url":"https://api.github.com/users/mapazarr/repos","events_url":"https://api.github.com/users/mapazarr/events{/privacy}","received_events_url":"https://api.github.com/users/mapazarr/received_events","type":"User","site_admin":false},"body":"While reviewing #299 by @mapazarr I noticed that the documentation for attributes is very verbose and basically repeats the same info twice:\r\n\r\n![screen shot 2015-07-15 at 11 13 00](https://cloud.githubusercontent.com/assets/852409/8694992/d1161168-2ae2-11e5-8f69-10b914ea3a26.png)\r\n\r\nI think I'd prefer we don't use `Returns` sections for attributes, but instead just have one line that also mentions the return type like I've done it here:\r\nhttps://gammapy.readthedocs.org/en/latest/api/gammapy.data.EventList.html\r\nIf more explanations are needed / wanted, that's OK, extra lines can be added.\r\nMy point is only that `Returns` doesn't make much sense because attributes always return exactly one thing, and that's already described in the first line.\r\n\r\n@mapazarr @adonath @kingj90 – What do you think?\r\n\r\nIf we agree on this, the TODOs here are:\r\n- [x] Add an entry explaining this convention here: https://gammapy.readthedocs.org/en/latest/development/index.html\r\n- [x] Go through the existing attributes and clean them up. E.g. [SpectralCube](https://gammapy.readthedocs.org/en/latest/api/gammapy.data.SpectralCube.html) ... there don't seem to be too many: https://github.com/gammapy/gammapy/search?utf8=%E2%9C%93&q=property","created_at":"2015-07-23T07:47:58Z","updated_at":"2015-08-02T06:06:48Z","closed_at":null,"merged_at":null,"merge_commit_sha":"67de4dd2fd764df0a6594ba60a7ece69e98c51fa","assignee":{"login":"cdeil","id":852409,"avatar_url":"https://avatars.githubusercontent.com/u/852409?v=3","gravatar_id":"","url":"https://api.github.com/users/cdeil","html_url":"https://github.com/cdeil","followers_url":"https://api.github.com/users/cdeil/followers","following_url":"https://api.github.com/users/cdeil/following{/other_user}","gists_url":"https://api.github.com/users/cdeil/gists{/gist_id}","starred_url":"https://api.github.com/users/cdeil/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/cdeil/subscriptions","organizations_url":"https://api.github.com/users/cdeil/orgs","repos_url":"https://api.github.com/users/cdeil/repos","events_url":"https://api.github.com/users/cdeil/events{/privacy}","received_events_url":"https://api.github.com/users/cdeil/received_events","type":"User","site_admin":false},"milestone":{"url":"https://api.github.com/repos/gammapy/gammapy/milestones/2","html_url":"https://github.com/gammapy/gammapy/milestones/0.3","labels_url":"https://api.github.com/repos/gammapy/gammapy/milestones/2/labels","id":377787,"number":2,"title":"0.3","description":"","creator":{"login":"cdeil","id":852409,"avatar_url":"https://avatars.githubusercontent.com/u/852409?v=3","gravatar_id":"","url":"https://api.github.com/users/cdeil","html_url":"https://github.com/cdeil","followers_url":"https://api.github.com/users/cdeil/followers","following_url":"https://api.github.com/users/cdeil/following{/other_user}","gists_url":"https://api.github.com/users/cdeil/gists{/gist_id}","starred_url":"https://api.github.com/users/cdeil/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/cdeil/subscriptions","organizations_url":"https://api.github.com/users/cdeil/orgs","repos_url":"https://api.github.com/users/cdeil/repos","events_url":"https://api.github.com/users/cdeil/events{/privacy}","received_events_url":"https://api.github.com/users/cdeil/received_events","type":"User","site_admin":false},"open_issues":28,"closed_issues":32,"state":"open","created_at":"2013-07-14T16:38:18Z","updated_at":"2015-08-01T12:59:31Z","due_on":"2015-08-02T22:00:00Z","closed_at":null},"commits_url":"https://api.github.com/repos/gammapy/gammapy/pulls/301/commits","review_comments_url":"https://api.github.com/repos/gammapy/gammapy/pulls/301/comments","review_comment_url":"https://api.github.com/repos/gammapy/gammapy/pulls/comments{/number}","comments_url":"https://api.github.com/repos/gammapy/gammapy/issues/301/comments","statuses_url":"https://api.github.com/repos/gammapy/gammapy/statuses/543505a2bb59eae7195354b2a384bdb889bb3648","head":{"label":"mapazarr:attribute_docstrings","ref":"attribute_docstrings","sha":"543505a2bb59eae7195354b2a384bdb889bb3648","user":{"login":"mapazarr","id":11326731,"avatar_url":"https://avatars.githubusercontent.com/u/11326731?v=3","gravatar_id":"","url":"https://api.github.com/users/mapazarr","html_url":"https://github.com/mapazarr","followers_url":"https://api.github.com/users/mapazarr/followers","following_url":"https://api.github.com/users/mapazarr/following{/other_user}","gists_url":"https://api.github.com/users/mapazarr/gists{/gist_id}","starred_url":"https://api.github.com/users/mapazarr/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/mapazarr/subscriptions","organizations_url":"https://api.github.com/users/mapazarr/orgs","repos_url":"https://api.github.com/users/mapazarr/repos","events_url":"https://api.github.com/users/mapazarr/events{/privacy}","received_events_url":"https://api.github.com/users/mapazarr/received_events","type":"User","site_admin":false},"repo":{"id":32351501,"name":"gammapy","full_name":"mapazarr/gammapy","owner":{"login":"mapazarr","id":11326731,"avatar_url":"https://avatars.githubusercontent.com/u/11326731?v=3","gravatar_id":"","url":"https://api.github.com/users/mapazarr","html_url":"https://github.com/mapazarr","followers_url":"https://api.github.com/users/mapazarr/followers","following_url":"https://api.github.com/users/mapazarr/following{/other_user}","gists_url":"https://api.github.com/users/mapazarr/gists{/gist_id}","starred_url":"https://api.github.com/users/mapazarr/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/mapazarr/subscriptions","organizations_url":"https://api.github.com/users/mapazarr/orgs","repos_url":"https://api.github.com/users/mapazarr/repos","events_url":"https://api.github.com/users/mapazarr/events{/privacy}","received_events_url":"https://api.github.com/users/mapazarr/received_events","type":"User","site_admin":false},"private":false,"html_url":"https://github.com/mapazarr/gammapy","description":"A Python package for gamma-ray astronomy","fork":true,"url":"https://api.github.com/repos/mapazarr/gammapy","forks_url":"https://api.github.com/repos/mapazarr/gammapy/forks","keys_url":"https://api.github.com/repos/mapazarr/gammapy/keys{/key_id}","collaborators_url":"https://api.github.com/repos/mapazarr/gammapy/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/mapazarr/gammapy/teams","hooks_url":"https://api.github.com/repos/mapazarr/gammapy/hooks","issue_events_url":"https://api.github.com/repos/mapazarr/gammapy/issues/events{/number}","events_url":"https://api.github.com/repos/mapazarr/gammapy/events","assignees_url":"https://api.github.com/repos/mapazarr/gammapy/assignees{/user}","branches_url":"https://api.github.com/repos/mapazarr/gammapy/branches{/branch}","tags_url":"https://api.github.com/repos/mapazarr/gammapy/tags","blobs_url":"https://api.github.com/repos/mapazarr/gammapy/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/mapazarr/gammapy/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/mapazarr/gammapy/git/refs{/sha}","trees_url":"https://api.github.com/repos/mapazarr/gammapy/git/trees{/sha}","statuses_url":"https://api.github.com/repos/mapazarr/gammapy/statuses/{sha}","languages_url":"https://api.github.com/repos/mapazarr/gammapy/languages","stargazers_url":"https://api.github.com/repos/mapazarr/gammapy/stargazers","contributors_url":"https://api.github.com/repos/mapazarr/gammapy/contributors","subscribers_url":"https://api.github.com/repos/mapazarr/gammapy/subscribers","subscription_url":"https://api.github.com/repos/mapazarr/gammapy/subscription","commits_url":"https://api.github.com/repos/mapazarr/gammapy/commits{/sha}","git_commits_url":"https://api.github.com/repos/mapazarr/gammapy/git/commits{/sha}","comments_url":"https://api.github.com/repos/mapazarr/gammapy/comments{/number}","issue_comment_url":"https://api.github.com/repos/mapazarr/gammapy/issues/comments{/number}","contents_url":"https://api.github.com/repos/mapazarr/gammapy/contents/{+path}","compare_url":"https://api.github.com/repos/mapazarr/gammapy/compare/{base}...{head}","merges_url":"https://api.github.com/repos/mapazarr/gammapy/merges","archive_url":"https://api.github.com/repos/mapazarr/gammapy/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/mapazarr/gammapy/downloads","issues_url":"https://api.github.com/repos/mapazarr/gammapy/issues{/number}","pulls_url":"https://api.github.com/repos/mapazarr/gammapy/pulls{/number}","milestones_url":"https://api.github.com/repos/mapazarr/gammapy/milestones{/number}","notifications_url":"https://api.github.com/repos/mapazarr/gammapy/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/mapazarr/gammapy/labels{/name}","releases_url":"https://api.github.com/repos/mapazarr/gammapy/releases{/id}","created_at":"2015-03-16T20:36:43Z","updated_at":"2015-04-09T23:35:39Z","pushed_at":"2015-08-01T08:08:45Z","git_url":"git://github.com/mapazarr/gammapy.git","ssh_url":"git@github.com:mapazarr/gammapy.git","clone_url":"https://github.com/mapazarr/gammapy.git","svn_url":"https://github.com/mapazarr/gammapy","homepage":"https://gammapy.readthedocs.org/","size":3284,"stargazers_count":0,"watchers_count":0,"language":"Python","has_issues":false,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":0,"mirror_url":null,"open_issues_count":0,"forks":0,"open_issues":0,"watchers":0,"default_branch":"master"}},"base":{"label":"gammapy:master","ref":"master","sha":"7f948309d27bb5b5f2f43103b7fa4c054a94e80c","user":{"login":"gammapy","id":852764,"avatar_url":"https://avatars.githubusercontent.com/u/852764?v=3","gravatar_id":"","url":"https://api.github.com/users/gammapy","html_url":"https://github.com/gammapy","followers_url":"https://api.github.com/users/gammapy/followers","following_url":"https://api.github.com/users/gammapy/following{/other_user}","gists_url":"https://api.github.com/users/gammapy/gists{/gist_id}","starred_url":"https://api.github.com/users/gammapy/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/gammapy/subscriptions","organizations_url":"https://api.github.com/users/gammapy/orgs","repos_url":"https://api.github.com/users/gammapy/repos","events_url":"https://api.github.com/users/gammapy/events{/privacy}","received_events_url":"https://api.github.com/users/gammapy/received_events","type":"Organization","site_admin":false},"repo":{"id":10073640,"name":"gammapy","full_name":"gammapy/gammapy","owner":{"login":"gammapy","id":852764,"avatar_url":"https://avatars.githubusercontent.com/u/852764?v=3","gravatar_id":"","url":"https://api.github.com/users/gammapy","html_url":"https://github.com/gammapy","followers_url":"https://api.github.com/users/gammapy/followers","following_url":"https://api.github.com/users/gammapy/following{/other_user}","gists_url":"https://api.github.com/users/gammapy/gists{/gist_id}","starred_url":"https://api.github.com/users/gammapy/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/gammapy/subscriptions","organizations_url":"https://api.github.com/users/gammapy/orgs","repos_url":"https://api.github.com/users/gammapy/repos","events_url":"https://api.github.com/users/gammapy/events{/privacy}","received_events_url":"https://api.github.com/users/gammapy/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/gammapy/gammapy","description":"A Python package for gamma-ray astronomy","fork":false,"url":"https://api.github.com/repos/gammapy/gammapy","forks_url":"https://api.github.com/repos/gammapy/gammapy/forks","keys_url":"https://api.github.com/repos/gammapy/gammapy/keys{/key_id}","collaborators_url":"https://api.github.com/repos/gammapy/gammapy/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/gammapy/gammapy/teams","hooks_url":"https://api.github.com/repos/gammapy/gammapy/hooks","issue_events_url":"https://api.github.com/repos/gammapy/gammapy/issues/events{/number}","events_url":"https://api.github.com/repos/gammapy/gammapy/events","assignees_url":"https://api.github.com/repos/gammapy/gammapy/assignees{/user}","branches_url":"https://api.github.com/repos/gammapy/gammapy/branches{/branch}","tags_url":"https://api.github.com/repos/gammapy/gammapy/tags","blobs_url":"https://api.github.com/repos/gammapy/gammapy/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/gammapy/gammapy/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/gammapy/gammapy/git/refs{/sha}","trees_url":"https://api.github.com/repos/gammapy/gammapy/git/trees{/sha}","statuses_url":"https://api.github.com/repos/gammapy/gammapy/statuses/{sha}","languages_url":"https://api.github.com/repos/gammapy/gammapy/languages","stargazers_url":"https://api.github.com/repos/gammapy/gammapy/stargazers","contributors_url":"https://api.github.com/repos/gammapy/gammapy/contributors","subscribers_url":"https://api.github.com/repos/gammapy/gammapy/subscribers","subscription_url":"https://api.github.com/repos/gammapy/gammapy/subscription","commits_url":"https://api.github.com/repos/gammapy/gammapy/commits{/sha}","git_commits_url":"https://api.github.com/repos/gammapy/gammapy/git/commits{/sha}","comments_url":"https://api.github.com/repos/gammapy/gammapy/comments{/number}","issue_comment_url":"https://api.github.com/repos/gammapy/gammapy/issues/comments{/number}","contents_url":"https://api.github.com/repos/gammapy/gammapy/contents/{+path}","compare_url":"https://api.github.com/repos/gammapy/gammapy/compare/{base}...{head}","merges_url":"https://api.github.com/repos/gammapy/gammapy/merges","archive_url":"https://api.github.com/repos/gammapy/gammapy/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/gammapy/gammapy/downloads","issues_url":"https://api.github.com/repos/gammapy/gammapy/issues{/number}","pulls_url":"https://api.github.com/repos/gammapy/gammapy/pulls{/number}","milestones_url":"https://api.github.com/repos/gammapy/gammapy/milestones{/number}","notifications_url":"https://api.github.com/repos/gammapy/gammapy/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/gammapy/gammapy/labels{/name}","releases_url":"https://api.github.com/repos/gammapy/gammapy/releases{/id}","created_at":"2013-05-15T07:50:40Z","updated_at":"2015-06-06T13:39:51Z","pushed_at":"2015-08-01T13:28:49Z","git_url":"git://github.com/gammapy/gammapy.git","ssh_url":"git@github.com:gammapy/gammapy.git","clone_url":"https://github.com/gammapy/gammapy.git","svn_url":"https://github.com/gammapy/gammapy","homepage":"https://gammapy.readthedocs.org/","size":5567,"stargazers_count":12,"watchers_count":12,"language":"Python","has_issues":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":21,"mirror_url":null,"open_issues_count":105,"forks":21,"open_issues":105,"watchers":12,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/gammapy/gammapy/pulls/301"},"html":{"href":"https://github.com/gammapy/gammapy/pull/301"},"issue":{"href":"https://api.github.com/repos/gammapy/gammapy/issues/301"},"comments":{"href":"https://api.github.com/repos/gammapy/gammapy/issues/301/comments"},"review_comments":{"href":"https://api.github.com/repos/gammapy/gammapy/pulls/301/comments"},"review_comment":{"href":"https://api.github.com/repos/gammapy/gammapy/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/gammapy/gammapy/pulls/301/commits"},"statuses":{"href":"https://api.github.com/repos/gammapy/gammapy/statuses/543505a2bb59eae7195354b2a384bdb889bb3648"}}}}