{"action":"created","comment":{"url":"https://api.github.com/repos/facebook/jest/pulls/comments/74532137","id":74532137,"diff_hunk":"@@ -308,8 +308,70 @@ just added.\n ## API\n \n <generated_api_start />\n+#### The Jest global environment","path":"README.md","position":4,"original_position":4,"commit_id":"9d442ed1814278697d2a1dcd3aaaaf4e67d96b83","original_commit_id":"9d442ed1814278697d2a1dcd3aaaaf4e67d96b83","user":{"login":"cpojer","id":13352,"avatar_url":"https://avatars.githubusercontent.com/u/13352?v=3","gravatar_id":"","url":"https://api.github.com/users/cpojer","html_url":"https://github.com/cpojer","followers_url":"https://api.github.com/users/cpojer/followers","following_url":"https://api.github.com/users/cpojer/following{/other_user}","gists_url":"https://api.github.com/users/cpojer/gists{/gist_id}","starred_url":"https://api.github.com/users/cpojer/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/cpojer/subscriptions","organizations_url":"https://api.github.com/users/cpojer/orgs","repos_url":"https://api.github.com/users/cpojer/repos","events_url":"https://api.github.com/users/cpojer/events{/privacy}","received_events_url":"https://api.github.com/users/cpojer/received_events","type":"User","site_admin":false},"body":"I'm wondering if adding simple flow types for all of these in the documentation is helpful or detrimental.\r\n\r\nFor example:\r\n\r\n```js\r\nrequire(moduleName: string);\r\n// vs\r\nrequire(moduleName)\r\n```\r\n\r\nWhat do you think?","created_at":"2016-08-12T01:47:22Z","updated_at":"2016-08-12T01:47:22Z","html_url":"https://github.com/facebook/jest/pull/1405#discussion_r74532137","pull_request_url":"https://api.github.com/repos/facebook/jest/pulls/1405","_links":{"self":{"href":"https://api.github.com/repos/facebook/jest/pulls/comments/74532137"},"html":{"href":"https://github.com/facebook/jest/pull/1405#discussion_r74532137"},"pull_request":{"href":"https://api.github.com/repos/facebook/jest/pulls/1405"}}},"pull_request":{"url":"https://api.github.com/repos/facebook/jest/pulls/1405","id":80888756,"html_url":"https://github.com/facebook/jest/pull/1405","diff_url":"https://github.com/facebook/jest/pull/1405.diff","patch_url":"https://github.com/facebook/jest/pull/1405.patch","issue_url":"https://api.github.com/repos/facebook/jest/issues/1405","number":1405,"state":"open","locked":false,"title":"Improving API documentation","user":{"login":"lacker","id":106475,"avatar_url":"https://avatars.githubusercontent.com/u/106475?v=3","gravatar_id":"","url":"https://api.github.com/users/lacker","html_url":"https://github.com/lacker","followers_url":"https://api.github.com/users/lacker/followers","following_url":"https://api.github.com/users/lacker/following{/other_user}","gists_url":"https://api.github.com/users/lacker/gists{/gist_id}","starred_url":"https://api.github.com/users/lacker/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/lacker/subscriptions","organizations_url":"https://api.github.com/users/lacker/orgs","repos_url":"https://api.github.com/users/lacker/repos","events_url":"https://api.github.com/users/lacker/events{/privacy}","received_events_url":"https://api.github.com/users/lacker/received_events","type":"User","site_admin":false},"body":"I reordered in terms of importance - \"expect\" first, \"mock functions\" next, \"configuration\" last - and added some documentation for everything on \"expect\". That I know about at least. Here's a screen shot of the new API doc page:\r\n\r\n![screencapture-localhost-8080-jest-docs-api-html-1470874106366-0](https://cloud.githubusercontent.com/assets/106475/17575359/8268a182-5f1d-11e6-9fbf-9069ef9638fe.png)\r\n\r\nThere is still more docs stuff to do, like I'd like to make sure everything in \"globals\" had some documentation. But for this PR I would mostly like to make sure that all the new info is correct, and not make it too much bigger. So let me know if things are erroneous.","created_at":"2016-08-11T00:12:55Z","updated_at":"2016-08-12T01:47:22Z","closed_at":null,"merged_at":null,"merge_commit_sha":"8759812130ff0ee1191264573ff3e7a2bf70c14d","assignee":null,"assignees":[],"milestone":null,"commits_url":"https://api.github.com/repos/facebook/jest/pulls/1405/commits","review_comments_url":"https://api.github.com/repos/facebook/jest/pulls/1405/comments","review_comment_url":"https://api.github.com/repos/facebook/jest/pulls/comments{/number}","comments_url":"https://api.github.com/repos/facebook/jest/issues/1405/comments","statuses_url":"https://api.github.com/repos/facebook/jest/statuses/9d442ed1814278697d2a1dcd3aaaaf4e67d96b83","head":{"label":"lacker:docfest","ref":"docfest","sha":"9d442ed1814278697d2a1dcd3aaaaf4e67d96b83","user":{"login":"lacker","id":106475,"avatar_url":"https://avatars.githubusercontent.com/u/106475?v=3","gravatar_id":"","url":"https://api.github.com/users/lacker","html_url":"https://github.com/lacker","followers_url":"https://api.github.com/users/lacker/followers","following_url":"https://api.github.com/users/lacker/following{/other_user}","gists_url":"https://api.github.com/users/lacker/gists{/gist_id}","starred_url":"https://api.github.com/users/lacker/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/lacker/subscriptions","organizations_url":"https://api.github.com/users/lacker/orgs","repos_url":"https://api.github.com/users/lacker/repos","events_url":"https://api.github.com/users/lacker/events{/privacy}","received_events_url":"https://api.github.com/users/lacker/received_events","type":"User","site_admin":false},"repo":{"id":65417620,"name":"jest","full_name":"lacker/jest","owner":{"login":"lacker","id":106475,"avatar_url":"https://avatars.githubusercontent.com/u/106475?v=3","gravatar_id":"","url":"https://api.github.com/users/lacker","html_url":"https://github.com/lacker","followers_url":"https://api.github.com/users/lacker/followers","following_url":"https://api.github.com/users/lacker/following{/other_user}","gists_url":"https://api.github.com/users/lacker/gists{/gist_id}","starred_url":"https://api.github.com/users/lacker/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/lacker/subscriptions","organizations_url":"https://api.github.com/users/lacker/orgs","repos_url":"https://api.github.com/users/lacker/repos","events_url":"https://api.github.com/users/lacker/events{/privacy}","received_events_url":"https://api.github.com/users/lacker/received_events","type":"User","site_admin":false},"private":false,"html_url":"https://github.com/lacker/jest","description":"Painless JavaScript Unit Testing.","fork":true,"url":"https://api.github.com/repos/lacker/jest","forks_url":"https://api.github.com/repos/lacker/jest/forks","keys_url":"https://api.github.com/repos/lacker/jest/keys{/key_id}","collaborators_url":"https://api.github.com/repos/lacker/jest/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/lacker/jest/teams","hooks_url":"https://api.github.com/repos/lacker/jest/hooks","issue_events_url":"https://api.github.com/repos/lacker/jest/issues/events{/number}","events_url":"https://api.github.com/repos/lacker/jest/events","assignees_url":"https://api.github.com/repos/lacker/jest/assignees{/user}","branches_url":"https://api.github.com/repos/lacker/jest/branches{/branch}","tags_url":"https://api.github.com/repos/lacker/jest/tags","blobs_url":"https://api.github.com/repos/lacker/jest/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/lacker/jest/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/lacker/jest/git/refs{/sha}","trees_url":"https://api.github.com/repos/lacker/jest/git/trees{/sha}","statuses_url":"https://api.github.com/repos/lacker/jest/statuses/{sha}","languages_url":"https://api.github.com/repos/lacker/jest/languages","stargazers_url":"https://api.github.com/repos/lacker/jest/stargazers","contributors_url":"https://api.github.com/repos/lacker/jest/contributors","subscribers_url":"https://api.github.com/repos/lacker/jest/subscribers","subscription_url":"https://api.github.com/repos/lacker/jest/subscription","commits_url":"https://api.github.com/repos/lacker/jest/commits{/sha}","git_commits_url":"https://api.github.com/repos/lacker/jest/git/commits{/sha}","comments_url":"https://api.github.com/repos/lacker/jest/comments{/number}","issue_comment_url":"https://api.github.com/repos/lacker/jest/issues/comments{/number}","contents_url":"https://api.github.com/repos/lacker/jest/contents/{+path}","compare_url":"https://api.github.com/repos/lacker/jest/compare/{base}...{head}","merges_url":"https://api.github.com/repos/lacker/jest/merges","archive_url":"https://api.github.com/repos/lacker/jest/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/lacker/jest/downloads","issues_url":"https://api.github.com/repos/lacker/jest/issues{/number}","pulls_url":"https://api.github.com/repos/lacker/jest/pulls{/number}","milestones_url":"https://api.github.com/repos/lacker/jest/milestones{/number}","notifications_url":"https://api.github.com/repos/lacker/jest/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/lacker/jest/labels{/name}","releases_url":"https://api.github.com/repos/lacker/jest/releases{/id}","deployments_url":"https://api.github.com/repos/lacker/jest/deployments","created_at":"2016-08-10T21:26:30Z","updated_at":"2016-08-10T21:26:32Z","pushed_at":"2016-08-11T23:52:56Z","git_url":"git://github.com/lacker/jest.git","ssh_url":"git@github.com:lacker/jest.git","clone_url":"https://github.com/lacker/jest.git","svn_url":"https://github.com/lacker/jest","homepage":"http://facebook.github.io/jest/","size":4308,"stargazers_count":0,"watchers_count":0,"language":"JavaScript","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":"facebook:master","ref":"master","sha":"b1a63ed7ac55bd8481ffeaa99b439c95a181814a","user":{"login":"facebook","id":69631,"avatar_url":"https://avatars.githubusercontent.com/u/69631?v=3","gravatar_id":"","url":"https://api.github.com/users/facebook","html_url":"https://github.com/facebook","followers_url":"https://api.github.com/users/facebook/followers","following_url":"https://api.github.com/users/facebook/following{/other_user}","gists_url":"https://api.github.com/users/facebook/gists{/gist_id}","starred_url":"https://api.github.com/users/facebook/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/facebook/subscriptions","organizations_url":"https://api.github.com/users/facebook/orgs","repos_url":"https://api.github.com/users/facebook/repos","events_url":"https://api.github.com/users/facebook/events{/privacy}","received_events_url":"https://api.github.com/users/facebook/received_events","type":"Organization","site_admin":false},"repo":{"id":15062869,"name":"jest","full_name":"facebook/jest","owner":{"login":"facebook","id":69631,"avatar_url":"https://avatars.githubusercontent.com/u/69631?v=3","gravatar_id":"","url":"https://api.github.com/users/facebook","html_url":"https://github.com/facebook","followers_url":"https://api.github.com/users/facebook/followers","following_url":"https://api.github.com/users/facebook/following{/other_user}","gists_url":"https://api.github.com/users/facebook/gists{/gist_id}","starred_url":"https://api.github.com/users/facebook/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/facebook/subscriptions","organizations_url":"https://api.github.com/users/facebook/orgs","repos_url":"https://api.github.com/users/facebook/repos","events_url":"https://api.github.com/users/facebook/events{/privacy}","received_events_url":"https://api.github.com/users/facebook/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/facebook/jest","description":"Painless JavaScript Unit Testing.","fork":false,"url":"https://api.github.com/repos/facebook/jest","forks_url":"https://api.github.com/repos/facebook/jest/forks","keys_url":"https://api.github.com/repos/facebook/jest/keys{/key_id}","collaborators_url":"https://api.github.com/repos/facebook/jest/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/facebook/jest/teams","hooks_url":"https://api.github.com/repos/facebook/jest/hooks","issue_events_url":"https://api.github.com/repos/facebook/jest/issues/events{/number}","events_url":"https://api.github.com/repos/facebook/jest/events","assignees_url":"https://api.github.com/repos/facebook/jest/assignees{/user}","branches_url":"https://api.github.com/repos/facebook/jest/branches{/branch}","tags_url":"https://api.github.com/repos/facebook/jest/tags","blobs_url":"https://api.github.com/repos/facebook/jest/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/facebook/jest/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/facebook/jest/git/refs{/sha}","trees_url":"https://api.github.com/repos/facebook/jest/git/trees{/sha}","statuses_url":"https://api.github.com/repos/facebook/jest/statuses/{sha}","languages_url":"https://api.github.com/repos/facebook/jest/languages","stargazers_url":"https://api.github.com/repos/facebook/jest/stargazers","contributors_url":"https://api.github.com/repos/facebook/jest/contributors","subscribers_url":"https://api.github.com/repos/facebook/jest/subscribers","subscription_url":"https://api.github.com/repos/facebook/jest/subscription","commits_url":"https://api.github.com/repos/facebook/jest/commits{/sha}","git_commits_url":"https://api.github.com/repos/facebook/jest/git/commits{/sha}","comments_url":"https://api.github.com/repos/facebook/jest/comments{/number}","issue_comment_url":"https://api.github.com/repos/facebook/jest/issues/comments{/number}","contents_url":"https://api.github.com/repos/facebook/jest/contents/{+path}","compare_url":"https://api.github.com/repos/facebook/jest/compare/{base}...{head}","merges_url":"https://api.github.com/repos/facebook/jest/merges","archive_url":"https://api.github.com/repos/facebook/jest/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/facebook/jest/downloads","issues_url":"https://api.github.com/repos/facebook/jest/issues{/number}","pulls_url":"https://api.github.com/repos/facebook/jest/pulls{/number}","milestones_url":"https://api.github.com/repos/facebook/jest/milestones{/number}","notifications_url":"https://api.github.com/repos/facebook/jest/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/facebook/jest/labels{/name}","releases_url":"https://api.github.com/repos/facebook/jest/releases{/id}","deployments_url":"https://api.github.com/repos/facebook/jest/deployments","created_at":"2013-12-10T00:18:04Z","updated_at":"2016-08-11T11:56:25Z","pushed_at":"2016-08-11T23:52:57Z","git_url":"git://github.com/facebook/jest.git","ssh_url":"git@github.com:facebook/jest.git","clone_url":"https://github.com/facebook/jest.git","svn_url":"https://github.com/facebook/jest","homepage":"http://facebook.github.io/jest/","size":6103,"stargazers_count":4487,"watchers_count":4487,"language":"JavaScript","has_issues":true,"has_downloads":true,"has_wiki":true,"has_pages":true,"forks_count":579,"mirror_url":null,"open_issues_count":72,"forks":579,"open_issues":72,"watchers":4487,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/facebook/jest/pulls/1405"},"html":{"href":"https://github.com/facebook/jest/pull/1405"},"issue":{"href":"https://api.github.com/repos/facebook/jest/issues/1405"},"comments":{"href":"https://api.github.com/repos/facebook/jest/issues/1405/comments"},"review_comments":{"href":"https://api.github.com/repos/facebook/jest/pulls/1405/comments"},"review_comment":{"href":"https://api.github.com/repos/facebook/jest/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/facebook/jest/pulls/1405/commits"},"statuses":{"href":"https://api.github.com/repos/facebook/jest/statuses/9d442ed1814278697d2a1dcd3aaaaf4e67d96b83"}}}}
{"actor":{"display_login":"cpojer"}}