{"action":"created","comment":{"url":"https://api.github.com/repos/cfelton/rhea/pulls/comments/74411972","id":74411972,"diff_hunk":"@@ -15,16 +15,18 @@\n \n \n class AvalonMM(MemoryMapped):\n+\n+    \"\"\"AvalonMM bus object\"\"\"\n+\n     name = 'avalon'\n \n     def __init__(self, glbl=None, data_width=8, address_width=16, name=None):\n-        \"\"\" AvalonMM bus object\n-        Parameters (kwargs):\n-        --------------------\n-        :param glbl: system clock and reset\n-        :param data_width: data bus width\n-        :param address_width: address bus width\n-        :param name: name for the bus\n+        \"\"\"","path":"rhea/system/memmap/avalonmm.py","position":17,"original_position":17,"commit_id":"3bb70932371fd26dbbe80dbd38c0422ef99ec509","original_commit_id":"3bb70932371fd26dbbe80dbd38c0422ef99ec509","user":{"login":"cfelton","id":766391,"avatar_url":"https://avatars.githubusercontent.com/u/766391?v=3","gravatar_id":"","url":"https://api.github.com/users/cfelton","html_url":"https://github.com/cfelton","followers_url":"https://api.github.com/users/cfelton/followers","following_url":"https://api.github.com/users/cfelton/following{/other_user}","gists_url":"https://api.github.com/users/cfelton/gists{/gist_id}","starred_url":"https://api.github.com/users/cfelton/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/cfelton/subscriptions","organizations_url":"https://api.github.com/users/cfelton/orgs","repos_url":"https://api.github.com/users/cfelton/repos","events_url":"https://api.github.com/users/cfelton/events{/privacy}","received_events_url":"https://api.github.com/users/cfelton/received_events","type":"User","site_admin":false},"body":"This docstring needs to be updated to the Google format outlined in sphinx-napolean:\r\nhttps://sphinxcontrib-napoleon.readthedocs.io/en/latest/#google-vs-numpy\r\n\r\nSome of the docstrings are old and I used the default format, but all docstrings should use the google format outlined in sphinx-napolean.  \r\n\r\nI also use \"Arguments\" for the ports and \"Parameters\" for parameters, this might be an odd usage and not sure how the autodoc will extract but it is useful (very useful) to separate the ports/interfaces and the parameters.","created_at":"2016-08-11T12:24:42Z","updated_at":"2016-08-11T12:24:42Z","html_url":"https://github.com/cfelton/rhea/pull/42#discussion_r74411972","pull_request_url":"https://api.github.com/repos/cfelton/rhea/pulls/42","_links":{"self":{"href":"https://api.github.com/repos/cfelton/rhea/pulls/comments/74411972"},"html":{"href":"https://github.com/cfelton/rhea/pull/42#discussion_r74411972"},"pull_request":{"href":"https://api.github.com/repos/cfelton/rhea/pulls/42"}}},"pull_request":{"url":"https://api.github.com/repos/cfelton/rhea/pulls/42","id":80738675,"html_url":"https://github.com/cfelton/rhea/pull/42","diff_url":"https://github.com/cfelton/rhea/pull/42.diff","patch_url":"https://github.com/cfelton/rhea/pull/42.patch","issue_url":"https://api.github.com/repos/cfelton/rhea/issues/42","number":42,"state":"open","locked":false,"title":"Reworking docs for the rhea system","user":{"login":"FelixVi","id":12435293,"avatar_url":"https://avatars.githubusercontent.com/u/12435293?v=3","gravatar_id":"","url":"https://api.github.com/users/FelixVi","html_url":"https://github.com/FelixVi","followers_url":"https://api.github.com/users/FelixVi/followers","following_url":"https://api.github.com/users/FelixVi/following{/other_user}","gists_url":"https://api.github.com/users/FelixVi/gists{/gist_id}","starred_url":"https://api.github.com/users/FelixVi/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/FelixVi/subscriptions","organizations_url":"https://api.github.com/users/FelixVi/orgs","repos_url":"https://api.github.com/users/FelixVi/repos","events_url":"https://api.github.com/users/FelixVi/events{/privacy}","received_events_url":"https://api.github.com/users/FelixVi/received_events","type":"User","site_admin":false},"body":"First PR including:\r\n1. Working in all existing files to the docs\r\n2. Converting docstrings so they show up cleanly in generated docs\r\n\r\nQuestions:\r\nShould we keep the empty doc files register_file and reference to make a template or should those go for now?\r\n\r\nIs the style of docstring fine? This is a first test to make sure modifications I make are done the way they should be\r\n\r\nIn my hands the coverage extension produces empty output files - have you had luck getting that to work? Using it would be nice to verify that all public functions are documented - or at least have a note that they need more docs :)","created_at":"2016-08-10T06:00:47Z","updated_at":"2016-08-11T12:24:42Z","closed_at":null,"merged_at":null,"merge_commit_sha":"276012360bbd0354574384ab646a907025bdb1a9","assignee":null,"assignees":[],"milestone":null,"commits_url":"https://api.github.com/repos/cfelton/rhea/pulls/42/commits","review_comments_url":"https://api.github.com/repos/cfelton/rhea/pulls/42/comments","review_comment_url":"https://api.github.com/repos/cfelton/rhea/pulls/comments{/number}","comments_url":"https://api.github.com/repos/cfelton/rhea/issues/42/comments","statuses_url":"https://api.github.com/repos/cfelton/rhea/statuses/3bb70932371fd26dbbe80dbd38c0422ef99ec509","head":{"label":"FelixVi:docs_system","ref":"docs_system","sha":"3bb70932371fd26dbbe80dbd38c0422ef99ec509","user":{"login":"FelixVi","id":12435293,"avatar_url":"https://avatars.githubusercontent.com/u/12435293?v=3","gravatar_id":"","url":"https://api.github.com/users/FelixVi","html_url":"https://github.com/FelixVi","followers_url":"https://api.github.com/users/FelixVi/followers","following_url":"https://api.github.com/users/FelixVi/following{/other_user}","gists_url":"https://api.github.com/users/FelixVi/gists{/gist_id}","starred_url":"https://api.github.com/users/FelixVi/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/FelixVi/subscriptions","organizations_url":"https://api.github.com/users/FelixVi/orgs","repos_url":"https://api.github.com/users/FelixVi/repos","events_url":"https://api.github.com/users/FelixVi/events{/privacy}","received_events_url":"https://api.github.com/users/FelixVi/received_events","type":"User","site_admin":false},"repo":{"id":63801088,"name":"rhea","full_name":"FelixVi/rhea","owner":{"login":"FelixVi","id":12435293,"avatar_url":"https://avatars.githubusercontent.com/u/12435293?v=3","gravatar_id":"","url":"https://api.github.com/users/FelixVi","html_url":"https://github.com/FelixVi","followers_url":"https://api.github.com/users/FelixVi/followers","following_url":"https://api.github.com/users/FelixVi/following{/other_user}","gists_url":"https://api.github.com/users/FelixVi/gists{/gist_id}","starred_url":"https://api.github.com/users/FelixVi/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/FelixVi/subscriptions","organizations_url":"https://api.github.com/users/FelixVi/orgs","repos_url":"https://api.github.com/users/FelixVi/repos","events_url":"https://api.github.com/users/FelixVi/events{/privacy}","received_events_url":"https://api.github.com/users/FelixVi/received_events","type":"User","site_admin":false},"private":false,"html_url":"https://github.com/FelixVi/rhea","description":"A collection of MyHDL cores and tools for complex digital circuit design","fork":true,"url":"https://api.github.com/repos/FelixVi/rhea","forks_url":"https://api.github.com/repos/FelixVi/rhea/forks","keys_url":"https://api.github.com/repos/FelixVi/rhea/keys{/key_id}","collaborators_url":"https://api.github.com/repos/FelixVi/rhea/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/FelixVi/rhea/teams","hooks_url":"https://api.github.com/repos/FelixVi/rhea/hooks","issue_events_url":"https://api.github.com/repos/FelixVi/rhea/issues/events{/number}","events_url":"https://api.github.com/repos/FelixVi/rhea/events","assignees_url":"https://api.github.com/repos/FelixVi/rhea/assignees{/user}","branches_url":"https://api.github.com/repos/FelixVi/rhea/branches{/branch}","tags_url":"https://api.github.com/repos/FelixVi/rhea/tags","blobs_url":"https://api.github.com/repos/FelixVi/rhea/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/FelixVi/rhea/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/FelixVi/rhea/git/refs{/sha}","trees_url":"https://api.github.com/repos/FelixVi/rhea/git/trees{/sha}","statuses_url":"https://api.github.com/repos/FelixVi/rhea/statuses/{sha}","languages_url":"https://api.github.com/repos/FelixVi/rhea/languages","stargazers_url":"https://api.github.com/repos/FelixVi/rhea/stargazers","contributors_url":"https://api.github.com/repos/FelixVi/rhea/contributors","subscribers_url":"https://api.github.com/repos/FelixVi/rhea/subscribers","subscription_url":"https://api.github.com/repos/FelixVi/rhea/subscription","commits_url":"https://api.github.com/repos/FelixVi/rhea/commits{/sha}","git_commits_url":"https://api.github.com/repos/FelixVi/rhea/git/commits{/sha}","comments_url":"https://api.github.com/repos/FelixVi/rhea/comments{/number}","issue_comment_url":"https://api.github.com/repos/FelixVi/rhea/issues/comments{/number}","contents_url":"https://api.github.com/repos/FelixVi/rhea/contents/{+path}","compare_url":"https://api.github.com/repos/FelixVi/rhea/compare/{base}...{head}","merges_url":"https://api.github.com/repos/FelixVi/rhea/merges","archive_url":"https://api.github.com/repos/FelixVi/rhea/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/FelixVi/rhea/downloads","issues_url":"https://api.github.com/repos/FelixVi/rhea/issues{/number}","pulls_url":"https://api.github.com/repos/FelixVi/rhea/pulls{/number}","milestones_url":"https://api.github.com/repos/FelixVi/rhea/milestones{/number}","notifications_url":"https://api.github.com/repos/FelixVi/rhea/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/FelixVi/rhea/labels{/name}","releases_url":"https://api.github.com/repos/FelixVi/rhea/releases{/id}","deployments_url":"https://api.github.com/repos/FelixVi/rhea/deployments","created_at":"2016-07-20T17:32:03Z","updated_at":"2016-07-20T17:32:04Z","pushed_at":"2016-08-11T04:21:06Z","git_url":"git://github.com/FelixVi/rhea.git","ssh_url":"git@github.com:FelixVi/rhea.git","clone_url":"https://github.com/FelixVi/rhea.git","svn_url":"https://github.com/FelixVi/rhea","homepage":"","size":1626,"stargazers_count":0,"watchers_count":0,"language":"Python","has_issues":false,"has_downloads":true,"has_wiki":false,"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":"cfelton:master","ref":"master","sha":"aae5e3f469f829f26f97387718d23a6d2c4315c1","user":{"login":"cfelton","id":766391,"avatar_url":"https://avatars.githubusercontent.com/u/766391?v=3","gravatar_id":"","url":"https://api.github.com/users/cfelton","html_url":"https://github.com/cfelton","followers_url":"https://api.github.com/users/cfelton/followers","following_url":"https://api.github.com/users/cfelton/following{/other_user}","gists_url":"https://api.github.com/users/cfelton/gists{/gist_id}","starred_url":"https://api.github.com/users/cfelton/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/cfelton/subscriptions","organizations_url":"https://api.github.com/users/cfelton/orgs","repos_url":"https://api.github.com/users/cfelton/repos","events_url":"https://api.github.com/users/cfelton/events{/privacy}","received_events_url":"https://api.github.com/users/cfelton/received_events","type":"User","site_admin":false},"repo":{"id":41548658,"name":"rhea","full_name":"cfelton/rhea","owner":{"login":"cfelton","id":766391,"avatar_url":"https://avatars.githubusercontent.com/u/766391?v=3","gravatar_id":"","url":"https://api.github.com/users/cfelton","html_url":"https://github.com/cfelton","followers_url":"https://api.github.com/users/cfelton/followers","following_url":"https://api.github.com/users/cfelton/following{/other_user}","gists_url":"https://api.github.com/users/cfelton/gists{/gist_id}","starred_url":"https://api.github.com/users/cfelton/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/cfelton/subscriptions","organizations_url":"https://api.github.com/users/cfelton/orgs","repos_url":"https://api.github.com/users/cfelton/repos","events_url":"https://api.github.com/users/cfelton/events{/privacy}","received_events_url":"https://api.github.com/users/cfelton/received_events","type":"User","site_admin":false},"private":false,"html_url":"https://github.com/cfelton/rhea","description":"A collection of MyHDL cores and tools for complex digital circuit design","fork":false,"url":"https://api.github.com/repos/cfelton/rhea","forks_url":"https://api.github.com/repos/cfelton/rhea/forks","keys_url":"https://api.github.com/repos/cfelton/rhea/keys{/key_id}","collaborators_url":"https://api.github.com/repos/cfelton/rhea/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/cfelton/rhea/teams","hooks_url":"https://api.github.com/repos/cfelton/rhea/hooks","issue_events_url":"https://api.github.com/repos/cfelton/rhea/issues/events{/number}","events_url":"https://api.github.com/repos/cfelton/rhea/events","assignees_url":"https://api.github.com/repos/cfelton/rhea/assignees{/user}","branches_url":"https://api.github.com/repos/cfelton/rhea/branches{/branch}","tags_url":"https://api.github.com/repos/cfelton/rhea/tags","blobs_url":"https://api.github.com/repos/cfelton/rhea/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/cfelton/rhea/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/cfelton/rhea/git/refs{/sha}","trees_url":"https://api.github.com/repos/cfelton/rhea/git/trees{/sha}","statuses_url":"https://api.github.com/repos/cfelton/rhea/statuses/{sha}","languages_url":"https://api.github.com/repos/cfelton/rhea/languages","stargazers_url":"https://api.github.com/repos/cfelton/rhea/stargazers","contributors_url":"https://api.github.com/repos/cfelton/rhea/contributors","subscribers_url":"https://api.github.com/repos/cfelton/rhea/subscribers","subscription_url":"https://api.github.com/repos/cfelton/rhea/subscription","commits_url":"https://api.github.com/repos/cfelton/rhea/commits{/sha}","git_commits_url":"https://api.github.com/repos/cfelton/rhea/git/commits{/sha}","comments_url":"https://api.github.com/repos/cfelton/rhea/comments{/number}","issue_comment_url":"https://api.github.com/repos/cfelton/rhea/issues/comments{/number}","contents_url":"https://api.github.com/repos/cfelton/rhea/contents/{+path}","compare_url":"https://api.github.com/repos/cfelton/rhea/compare/{base}...{head}","merges_url":"https://api.github.com/repos/cfelton/rhea/merges","archive_url":"https://api.github.com/repos/cfelton/rhea/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/cfelton/rhea/downloads","issues_url":"https://api.github.com/repos/cfelton/rhea/issues{/number}","pulls_url":"https://api.github.com/repos/cfelton/rhea/pulls{/number}","milestones_url":"https://api.github.com/repos/cfelton/rhea/milestones{/number}","notifications_url":"https://api.github.com/repos/cfelton/rhea/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/cfelton/rhea/labels{/name}","releases_url":"https://api.github.com/repos/cfelton/rhea/releases{/id}","deployments_url":"https://api.github.com/repos/cfelton/rhea/deployments","created_at":"2015-08-28T13:28:32Z","updated_at":"2016-07-27T14:14:38Z","pushed_at":"2016-08-11T04:21:06Z","git_url":"git://github.com/cfelton/rhea.git","ssh_url":"git@github.com:cfelton/rhea.git","clone_url":"https://github.com/cfelton/rhea.git","svn_url":"https://github.com/cfelton/rhea","homepage":"","size":1634,"stargazers_count":22,"watchers_count":22,"language":"Python","has_issues":true,"has_downloads":true,"has_wiki":false,"has_pages":false,"forks_count":20,"mirror_url":null,"open_issues_count":11,"forks":20,"open_issues":11,"watchers":22,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/cfelton/rhea/pulls/42"},"html":{"href":"https://github.com/cfelton/rhea/pull/42"},"issue":{"href":"https://api.github.com/repos/cfelton/rhea/issues/42"},"comments":{"href":"https://api.github.com/repos/cfelton/rhea/issues/42/comments"},"review_comments":{"href":"https://api.github.com/repos/cfelton/rhea/pulls/42/comments"},"review_comment":{"href":"https://api.github.com/repos/cfelton/rhea/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/cfelton/rhea/pulls/42/commits"},"statuses":{"href":"https://api.github.com/repos/cfelton/rhea/statuses/3bb70932371fd26dbbe80dbd38c0422ef99ec509"}}}}
{"actor":{"display_login":"cfelton"}}