GitHub PullRequestReviewCommentEvent at 2014-12-12 21:32:44
Repository: doc_yo_self
Actor: rickcarlino
Payload: {"action":"created","comment":{"url":"https://api.github.com/repos/rickcarlino/doc_yo_self/pulls/comments/21774778","id":21774778,"diff_hunk":"@@ -71,20 +72,21 @@ end\n \n It will log all requests and responses by default, but you can add some **optional** parameters as well.\n \n-### Skipping documentation\n \n+## Adding notes\n+Defaults to the test name\n ```ruby\n-def test_stuff\n-  DocYoSelf.skip\n-  # Blahhh\n-end\n+DocYoSelf.new(self, note: \"This is fun\")","path":"README.md","position":64,"original_position":64,"commit_id":"f5a4b90573835cef081c4947f290f8442985dcf5","original_commit_id":"f5a4b90573835cef081c4947f290f8442985dcf5","user":{"login":"rickcarlino","id":1388608,"avatar_url":"https://avatars.githubusercontent.com/u/1388608?v=3","gravatar_id":"","url":"https://api.github.com/users/rickcarlino","html_url":"https://github.com/rickcarlino","followers_url":"https://api.github.com/users/rickcarlino/followers","following_url":"https://api.github.com/users/rickcarlino/following{/other_user}","gists_url":"https://api.github.com/users/rickcarlino/gists{/gist_id}","starred_url":"https://api.github.com/users/rickcarlino/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/rickcarlino/subscriptions","organizations_url":"https://api.github.com/users/rickcarlino/orgs","repos_url":"https://api.github.com/users/rickcarlino/repos","events_url":"https://api.github.com/users/rickcarlino/events{/privacy}","received_events_url":"https://api.github.com/users/rickcarlino/received_events","type":"User","site_admin":false},"body":"Is it possible to pass in a note after the object has been initialized?\r\n\r\nIdeally, DocYoSelf would work by being set in a default `before` or `setup` step somewhere that is out of view from the person who writes the test. Later, if they decide to do so, they can add a note (or skip documentation) without needing to re write the setup step.\r\n\r\nIs that possible with your proposed changes?","created_at":"2014-12-12T21:32:44Z","updated_at":"2014-12-12T21:32:44Z","html_url":"https://github.com/rickcarlino/doc_yo_self/pull/2#discussion_r21774778","pull_request_url":"https://api.github.com/repos/rickcarlino/doc_yo_self/pulls/2","_links":{"self":{"href":"https://api.github.com/repos/rickcarlino/doc_yo_self/pulls/comments/21774778"},"html":{"href":"https://github.com/rickcarlino/doc_yo_self/pull/2#discussion_r21774778"},"pull_request":{"href":"https://api.github.com/repos/rickcarlino/doc_yo_self/pulls/2"}}},"pull_request":{"url":"https://api.github.com/repos/rickcarlino/doc_yo_self/pulls/2","id":25773777,"html_url":"https://github.com/rickcarlino/doc_yo_self/pull/2","diff_url":"https://github.com/rickcarlino/doc_yo_self/pull/2.diff","patch_url":"https://github.com/rickcarlino/doc_yo_self/pull/2.patch","issue_url":"https://api.github.com/repos/rickcarlino/doc_yo_self/issues/2","number":2,"state":"open","locked":false,"title":"Refactor","user":{"login":"elfassy","id":311279,"avatar_url":"https://avatars.githubusercontent.com/u/311279?v=3","gravatar_id":"","url":"https://api.github.com/users/elfassy","html_url":"https://github.com/elfassy","followers_url":"https://api.github.com/users/elfassy/followers","following_url":"https://api.github.com/users/elfassy/following{/other_user}","gists_url":"https://api.github.com/users/elfassy/gists{/gist_id}","starred_url":"https://api.github.com/users/elfassy/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/elfassy/subscriptions","organizations_url":"https://api.github.com/users/elfassy/orgs","repos_url":"https://api.github.com/users/elfassy/repos","events_url":"https://api.github.com/users/elfassy/events{/privacy}","received_events_url":"https://api.github.com/users/elfassy/received_events","type":"User","site_admin":false},"body":"- auto generate notes based on test 'it' description\r\n- use class instances instead of singleton\r\n- threadsafe\r\n- generate one doc file per test file\r\n- better template example","created_at":"2014-12-09T20:24:23Z","updated_at":"2014-12-12T21:32:44Z","closed_at":null,"merged_at":null,"merge_commit_sha":"2f625410163107524e15b21e637d539bae2f4f74","assignee":null,"milestone":null,"commits_url":"https://api.github.com/repos/rickcarlino/doc_yo_self/pulls/2/commits","review_comments_url":"https://api.github.com/repos/rickcarlino/doc_yo_self/pulls/2/comments","review_comment_url":"https://api.github.com/repos/rickcarlino/doc_yo_self/pulls/comments/{number}","comments_url":"https://api.github.com/repos/rickcarlino/doc_yo_self/issues/2/comments","statuses_url":"https://api.github.com/repos/rickcarlino/doc_yo_self/statuses/f5a4b90573835cef081c4947f290f8442985dcf5","head":{"label":"elfassy:master","ref":"master","sha":"f5a4b90573835cef081c4947f290f8442985dcf5","user":{"login":"elfassy","id":311279,"avatar_url":"https://avatars.githubusercontent.com/u/311279?v=3","gravatar_id":"","url":"https://api.github.com/users/elfassy","html_url":"https://github.com/elfassy","followers_url":"https://api.github.com/users/elfassy/followers","following_url":"https://api.github.com/users/elfassy/following{/other_user}","gists_url":"https://api.github.com/users/elfassy/gists{/gist_id}","starred_url":"https://api.github.com/users/elfassy/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/elfassy/subscriptions","organizations_url":"https://api.github.com/users/elfassy/orgs","repos_url":"https://api.github.com/users/elfassy/repos","events_url":"https://api.github.com/users/elfassy/events{/privacy}","received_events_url":"https://api.github.com/users/elfassy/received_events","type":"User","site_admin":false},"repo":{"id":26499778,"name":"doc_yo_self","full_name":"elfassy/doc_yo_self","owner":{"login":"elfassy","id":311279,"avatar_url":"https://avatars.githubusercontent.com/u/311279?v=3","gravatar_id":"","url":"https://api.github.com/users/elfassy","html_url":"https://github.com/elfassy","followers_url":"https://api.github.com/users/elfassy/followers","following_url":"https://api.github.com/users/elfassy/following{/other_user}","gists_url":"https://api.github.com/users/elfassy/gists{/gist_id}","starred_url":"https://api.github.com/users/elfassy/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/elfassy/subscriptions","organizations_url":"https://api.github.com/users/elfassy/orgs","repos_url":"https://api.github.com/users/elfassy/repos","events_url":"https://api.github.com/users/elfassy/events{/privacy}","received_events_url":"https://api.github.com/users/elfassy/received_events","type":"User","site_admin":false},"private":false,"html_url":"https://github.com/elfassy/doc_yo_self","description":"Turn controller tests into API docs.","fork":true,"url":"https://api.github.com/repos/elfassy/doc_yo_self","forks_url":"https://api.github.com/repos/elfassy/doc_yo_self/forks","keys_url":"https://api.github.com/repos/elfassy/doc_yo_self/keys{/key_id}","collaborators_url":"https://api.github.com/repos/elfassy/doc_yo_self/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/elfassy/doc_yo_self/teams","hooks_url":"https://api.github.com/repos/elfassy/doc_yo_self/hooks","issue_events_url":"https://api.github.com/repos/elfassy/doc_yo_self/issues/events{/number}","events_url":"https://api.github.com/repos/elfassy/doc_yo_self/events","assignees_url":"https://api.github.com/repos/elfassy/doc_yo_self/assignees{/user}","branches_url":"https://api.github.com/repos/elfassy/doc_yo_self/branches{/branch}","tags_url":"https://api.github.com/repos/elfassy/doc_yo_self/tags","blobs_url":"https://api.github.com/repos/elfassy/doc_yo_self/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/elfassy/doc_yo_self/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/elfassy/doc_yo_self/git/refs{/sha}","trees_url":"https://api.github.com/repos/elfassy/doc_yo_self/git/trees{/sha}","statuses_url":"https://api.github.com/repos/elfassy/doc_yo_self/statuses/{sha}","languages_url":"https://api.github.com/repos/elfassy/doc_yo_self/languages","stargazers_url":"https://api.github.com/repos/elfassy/doc_yo_self/stargazers","contributors_url":"https://api.github.com/repos/elfassy/doc_yo_self/contributors","subscribers_url":"https://api.github.com/repos/elfassy/doc_yo_self/subscribers","subscription_url":"https://api.github.com/repos/elfassy/doc_yo_self/subscription","commits_url":"https://api.github.com/repos/elfassy/doc_yo_self/commits{/sha}","git_commits_url":"https://api.github.com/repos/elfassy/doc_yo_self/git/commits{/sha}","comments_url":"https://api.github.com/repos/elfassy/doc_yo_self/comments{/number}","issue_comment_url":"https://api.github.com/repos/elfassy/doc_yo_self/issues/comments/{number}","contents_url":"https://api.github.com/repos/elfassy/doc_yo_self/contents/{+path}","compare_url":"https://api.github.com/repos/elfassy/doc_yo_self/compare/{base}...{head}","merges_url":"https://api.github.com/repos/elfassy/doc_yo_self/merges","archive_url":"https://api.github.com/repos/elfassy/doc_yo_self/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/elfassy/doc_yo_self/downloads","issues_url":"https://api.github.com/repos/elfassy/doc_yo_self/issues{/number}","pulls_url":"https://api.github.com/repos/elfassy/doc_yo_self/pulls{/number}","milestones_url":"https://api.github.com/repos/elfassy/doc_yo_self/milestones{/number}","notifications_url":"https://api.github.com/repos/elfassy/doc_yo_self/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/elfassy/doc_yo_self/labels{/name}","releases_url":"https://api.github.com/repos/elfassy/doc_yo_self/releases{/id}","created_at":"2014-11-11T19:08:02Z","updated_at":"2014-11-12T14:04:27Z","pushed_at":"2014-11-12T15:07:11Z","git_url":"git://github.com/elfassy/doc_yo_self.git","ssh_url":"git@github.com:elfassy/doc_yo_self.git","clone_url":"https://github.com/elfassy/doc_yo_self.git","svn_url":"https://github.com/elfassy/doc_yo_self","homepage":"","size":200,"stargazers_count":0,"watchers_count":0,"language":"Ruby","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":"rickcarlino:master","ref":"master","sha":"03e7992bab8e19b12745ab39fdf3506681d6525f","user":{"login":"rickcarlino","id":1388608,"avatar_url":"https://avatars.githubusercontent.com/u/1388608?v=3","gravatar_id":"","url":"https://api.github.com/users/rickcarlino","html_url":"https://github.com/rickcarlino","followers_url":"https://api.github.com/users/rickcarlino/followers","following_url":"https://api.github.com/users/rickcarlino/following{/other_user}","gists_url":"https://api.github.com/users/rickcarlino/gists{/gist_id}","starred_url":"https://api.github.com/users/rickcarlino/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/rickcarlino/subscriptions","organizations_url":"https://api.github.com/users/rickcarlino/orgs","repos_url":"https://api.github.com/users/rickcarlino/repos","events_url":"https://api.github.com/users/rickcarlino/events{/privacy}","received_events_url":"https://api.github.com/users/rickcarlino/received_events","type":"User","site_admin":false},"repo":{"id":23466248,"name":"doc_yo_self","full_name":"rickcarlino/doc_yo_self","owner":{"login":"rickcarlino","id":1388608,"avatar_url":"https://avatars.githubusercontent.com/u/1388608?v=3","gravatar_id":"","url":"https://api.github.com/users/rickcarlino","html_url":"https://github.com/rickcarlino","followers_url":"https://api.github.com/users/rickcarlino/followers","following_url":"https://api.github.com/users/rickcarlino/following{/other_user}","gists_url":"https://api.github.com/users/rickcarlino/gists{/gist_id}","starred_url":"https://api.github.com/users/rickcarlino/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/rickcarlino/subscriptions","organizations_url":"https://api.github.com/users/rickcarlino/orgs","repos_url":"https://api.github.com/users/rickcarlino/repos","events_url":"https://api.github.com/users/rickcarlino/events{/privacy}","received_events_url":"https://api.github.com/users/rickcarlino/received_events","type":"User","site_admin":false},"private":false,"html_url":"https://github.com/rickcarlino/doc_yo_self","description":"Turn controller tests into API docs.","fork":false,"url":"https://api.github.com/repos/rickcarlino/doc_yo_self","forks_url":"https://api.github.com/repos/rickcarlino/doc_yo_self/forks","keys_url":"https://api.github.com/repos/rickcarlino/doc_yo_self/keys{/key_id}","collaborators_url":"https://api.github.com/repos/rickcarlino/doc_yo_self/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/rickcarlino/doc_yo_self/teams","hooks_url":"https://api.github.com/repos/rickcarlino/doc_yo_self/hooks","issue_events_url":"https://api.github.com/repos/rickcarlino/doc_yo_self/issues/events{/number}","events_url":"https://api.github.com/repos/rickcarlino/doc_yo_self/events","assignees_url":"https://api.github.com/repos/rickcarlino/doc_yo_self/assignees{/user}","branches_url":"https://api.github.com/repos/rickcarlino/doc_yo_self/branches{/branch}","tags_url":"https://api.github.com/repos/rickcarlino/doc_yo_self/tags","blobs_url":"https://api.github.com/repos/rickcarlino/doc_yo_self/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/rickcarlino/doc_yo_self/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/rickcarlino/doc_yo_self/git/refs{/sha}","trees_url":"https://api.github.com/repos/rickcarlino/doc_yo_self/git/trees{/sha}","statuses_url":"https://api.github.com/repos/rickcarlino/doc_yo_self/statuses/{sha}","languages_url":"https://api.github.com/repos/rickcarlino/doc_yo_self/languages","stargazers_url":"https://api.github.com/repos/rickcarlino/doc_yo_self/stargazers","contributors_url":"https://api.github.com/repos/rickcarlino/doc_yo_self/contributors","subscribers_url":"https://api.github.com/repos/rickcarlino/doc_yo_self/subscribers","subscription_url":"https://api.github.com/repos/rickcarlino/doc_yo_self/subscription","commits_url":"https://api.github.com/repos/rickcarlino/doc_yo_self/commits{/sha}","git_commits_url":"https://api.github.com/repos/rickcarlino/doc_yo_self/git/commits{/sha}","comments_url":"https://api.github.com/repos/rickcarlino/doc_yo_self/comments{/number}","issue_comment_url":"https://api.github.com/repos/rickcarlino/doc_yo_self/issues/comments/{number}","contents_url":"https://api.github.com/repos/rickcarlino/doc_yo_self/contents/{+path}","compare_url":"https://api.github.com/repos/rickcarlino/doc_yo_self/compare/{base}...{head}","merges_url":"https://api.github.com/repos/rickcarlino/doc_yo_self/merges","archive_url":"https://api.github.com/repos/rickcarlino/doc_yo_self/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/rickcarlino/doc_yo_self/downloads","issues_url":"https://api.github.com/repos/rickcarlino/doc_yo_self/issues{/number}","pulls_url":"https://api.github.com/repos/rickcarlino/doc_yo_self/pulls{/number}","milestones_url":"https://api.github.com/repos/rickcarlino/doc_yo_self/milestones{/number}","notifications_url":"https://api.github.com/repos/rickcarlino/doc_yo_self/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/rickcarlino/doc_yo_self/labels{/name}","releases_url":"https://api.github.com/repos/rickcarlino/doc_yo_self/releases{/id}","created_at":"2014-08-29T14:18:00Z","updated_at":"2014-09-22T00:35:27Z","pushed_at":"2014-09-22T00:36:41Z","git_url":"git://github.com/rickcarlino/doc_yo_self.git","ssh_url":"git@github.com:rickcarlino/doc_yo_self.git","clone_url":"https://github.com/rickcarlino/doc_yo_self.git","svn_url":"https://github.com/rickcarlino/doc_yo_self","homepage":"","size":288,"stargazers_count":1,"watchers_count":1,"language":"Ruby","has_issues":true,"has_downloads":true,"has_wiki":false,"has_pages":false,"forks_count":1,"mirror_url":null,"open_issues_count":2,"forks":1,"open_issues":2,"watchers":1,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/rickcarlino/doc_yo_self/pulls/2"},"html":{"href":"https://github.com/rickcarlino/doc_yo_self/pull/2"},"issue":{"href":"https://api.github.com/repos/rickcarlino/doc_yo_self/issues/2"},"comments":{"href":"https://api.github.com/repos/rickcarlino/doc_yo_self/issues/2/comments"},"review_comments":{"href":"https://api.github.com/repos/rickcarlino/doc_yo_self/pulls/2/comments"},"review_comment":{"href":"https://api.github.com/repos/rickcarlino/doc_yo_self/pulls/comments/{number}"},"commits":{"href":"https://api.github.com/repos/rickcarlino/doc_yo_self/pulls/2/commits"},"statuses":{"href":"https://api.github.com/repos/rickcarlino/doc_yo_self/statuses/f5a4b90573835cef081c4947f290f8442985dcf5"}}}}