{"action":"closed","number":1368,"pull_request":{"url":"https://api.github.com/repos/tensorflow/tfjs-core/pulls/1368","id":227414309,"node_id":"MDExOlB1bGxSZXF1ZXN0MjI3NDE0MzA5","html_url":"https://github.com/tensorflow/tfjs-core/pull/1368","diff_url":"https://github.com/tensorflow/tfjs-core/pull/1368.diff","patch_url":"https://github.com/tensorflow/tfjs-core/pull/1368.patch","issue_url":"https://api.github.com/repos/tensorflow/tfjs-core/issues/1368","number":1368,"state":"closed","locked":false,"title":"Add docs for tf.io.browserFiles() and tf.io.browserDownloads()","user":{"login":"jeancochrane","id":14170650,"node_id":"MDQ6VXNlcjE0MTcwNjUw","avatar_url":"https://avatars3.githubusercontent.com/u/14170650?v=4","gravatar_id":"","url":"https://api.github.com/users/jeancochrane","html_url":"https://github.com/jeancochrane","followers_url":"https://api.github.com/users/jeancochrane/followers","following_url":"https://api.github.com/users/jeancochrane/following{/other_user}","gists_url":"https://api.github.com/users/jeancochrane/gists{/gist_id}","starred_url":"https://api.github.com/users/jeancochrane/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/jeancochrane/subscriptions","organizations_url":"https://api.github.com/users/jeancochrane/orgs","repos_url":"https://api.github.com/users/jeancochrane/repos","events_url":"https://api.github.com/users/jeancochrane/events{/privacy}","received_events_url":"https://api.github.com/users/jeancochrane/received_events","type":"User","site_admin":false},"body":"#### Description\r\n<!--\r\nPlease describe the pull request here.\r\nAlso, if this is an issue/bug fix, please add the issue link for reference here.\r\n-->\r\n\r\nThis PR adds JSDoc marks to the methods `tf.io.browserFiles()` and `tf.io.browserDownloads()` to make sure that they get compiled into the web documentation. Note that these methods already had docstrings, they just weren't marked for the web docs.\r\n\r\nI wasn't quite sure under what subheading they would fit best, so I went with `Model / Loading` which seemed to be the most relevant existing subheading. If you think it'd be better to move them elsewhere, let me know!\r\n\r\nCloses https://github.com/tensorflow/tfjs/issues/839.\r\n\r\n\r\n#### Demo\r\n\r\nHere's what the two methods look like on the docs page, developing locally:\r\n\r\n![browserdownloads](https://user-images.githubusercontent.com/14170650/47814237-82a14100-dd23-11e8-89e0-fe69a206863f.png)\r\n![browserfiles](https://user-images.githubusercontent.com/14170650/47814238-846b0480-dd23-11e8-84ba-629f8cc20096.png)\r\n\r\n\r\n---\r\n<!-- Please do not delete this section -->\r\n##### For repository owners only:\r\n\r\nPlease remember to apply all applicable tags to your pull request.\r\nTags: FEATURE, BREAKING, BUG, PERF, DEV, DOC, SECURITY\r\n\r\nFor more info see: https://github.com/tensorflow/tfjs/blob/master/DEVELOPMENT.md\r\n\r\n<!-- Reviewable:start -->\r\n---\r\nThis change is [<img src=\"https://reviewable.io/review_button.svg\" height=\"34\" align=\"absmiddle\" alt=\"Reviewable\"/>](https://reviewable.io/reviews/tensorflow/tfjs-core/1368)\r\n<!-- Reviewable:end -->\r\n","created_at":"2018-10-31T19:28:08Z","updated_at":"2018-11-08T18:10:33Z","closed_at":"2018-11-08T18:10:33Z","merged_at":"2018-11-08T18:10:33Z","merge_commit_sha":"57397be6c58107a577976e819fc3480fe435fd01","assignee":null,"assignees":[],"requested_reviewers":[],"requested_teams":[],"labels":[],"milestone":null,"commits_url":"https://api.github.com/repos/tensorflow/tfjs-core/pulls/1368/commits","review_comments_url":"https://api.github.com/repos/tensorflow/tfjs-core/pulls/1368/comments","review_comment_url":"https://api.github.com/repos/tensorflow/tfjs-core/pulls/comments{/number}","comments_url":"https://api.github.com/repos/tensorflow/tfjs-core/issues/1368/comments","statuses_url":"https://api.github.com/repos/tensorflow/tfjs-core/statuses/462646c1d09041396bcb803351145a2a14d81904","head":{"label":"jeancochrane:add-browserfiles-docs","ref":"add-browserfiles-docs","sha":"462646c1d09041396bcb803351145a2a14d81904","user":{"login":"jeancochrane","id":14170650,"node_id":"MDQ6VXNlcjE0MTcwNjUw","avatar_url":"https://avatars3.githubusercontent.com/u/14170650?v=4","gravatar_id":"","url":"https://api.github.com/users/jeancochrane","html_url":"https://github.com/jeancochrane","followers_url":"https://api.github.com/users/jeancochrane/followers","following_url":"https://api.github.com/users/jeancochrane/following{/other_user}","gists_url":"https://api.github.com/users/jeancochrane/gists{/gist_id}","starred_url":"https://api.github.com/users/jeancochrane/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/jeancochrane/subscriptions","organizations_url":"https://api.github.com/users/jeancochrane/orgs","repos_url":"https://api.github.com/users/jeancochrane/repos","events_url":"https://api.github.com/users/jeancochrane/events{/privacy}","received_events_url":"https://api.github.com/users/jeancochrane/received_events","type":"User","site_admin":false},"repo":{"id":155572763,"node_id":"MDEwOlJlcG9zaXRvcnkxNTU1NzI3NjM=","name":"tfjs-core","full_name":"jeancochrane/tfjs-core","private":false,"owner":{"login":"jeancochrane","id":14170650,"node_id":"MDQ6VXNlcjE0MTcwNjUw","avatar_url":"https://avatars3.githubusercontent.com/u/14170650?v=4","gravatar_id":"","url":"https://api.github.com/users/jeancochrane","html_url":"https://github.com/jeancochrane","followers_url":"https://api.github.com/users/jeancochrane/followers","following_url":"https://api.github.com/users/jeancochrane/following{/other_user}","gists_url":"https://api.github.com/users/jeancochrane/gists{/gist_id}","starred_url":"https://api.github.com/users/jeancochrane/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/jeancochrane/subscriptions","organizations_url":"https://api.github.com/users/jeancochrane/orgs","repos_url":"https://api.github.com/users/jeancochrane/repos","events_url":"https://api.github.com/users/jeancochrane/events{/privacy}","received_events_url":"https://api.github.com/users/jeancochrane/received_events","type":"User","site_admin":false},"html_url":"https://github.com/jeancochrane/tfjs-core","description":"WebGL-accelerated ML // linear algebra // automatic differentiation for JavaScript.","fork":true,"url":"https://api.github.com/repos/jeancochrane/tfjs-core","forks_url":"https://api.github.com/repos/jeancochrane/tfjs-core/forks","keys_url":"https://api.github.com/repos/jeancochrane/tfjs-core/keys{/key_id}","collaborators_url":"https://api.github.com/repos/jeancochrane/tfjs-core/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/jeancochrane/tfjs-core/teams","hooks_url":"https://api.github.com/repos/jeancochrane/tfjs-core/hooks","issue_events_url":"https://api.github.com/repos/jeancochrane/tfjs-core/issues/events{/number}","events_url":"https://api.github.com/repos/jeancochrane/tfjs-core/events","assignees_url":"https://api.github.com/repos/jeancochrane/tfjs-core/assignees{/user}","branches_url":"https://api.github.com/repos/jeancochrane/tfjs-core/branches{/branch}","tags_url":"https://api.github.com/repos/jeancochrane/tfjs-core/tags","blobs_url":"https://api.github.com/repos/jeancochrane/tfjs-core/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/jeancochrane/tfjs-core/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/jeancochrane/tfjs-core/git/refs{/sha}","trees_url":"https://api.github.com/repos/jeancochrane/tfjs-core/git/trees{/sha}","statuses_url":"https://api.github.com/repos/jeancochrane/tfjs-core/statuses/{sha}","languages_url":"https://api.github.com/repos/jeancochrane/tfjs-core/languages","stargazers_url":"https://api.github.com/repos/jeancochrane/tfjs-core/stargazers","contributors_url":"https://api.github.com/repos/jeancochrane/tfjs-core/contributors","subscribers_url":"https://api.github.com/repos/jeancochrane/tfjs-core/subscribers","subscription_url":"https://api.github.com/repos/jeancochrane/tfjs-core/subscription","commits_url":"https://api.github.com/repos/jeancochrane/tfjs-core/commits{/sha}","git_commits_url":"https://api.github.com/repos/jeancochrane/tfjs-core/git/commits{/sha}","comments_url":"https://api.github.com/repos/jeancochrane/tfjs-core/comments{/number}","issue_comment_url":"https://api.github.com/repos/jeancochrane/tfjs-core/issues/comments{/number}","contents_url":"https://api.github.com/repos/jeancochrane/tfjs-core/contents/{+path}","compare_url":"https://api.github.com/repos/jeancochrane/tfjs-core/compare/{base}...{head}","merges_url":"https://api.github.com/repos/jeancochrane/tfjs-core/merges","archive_url":"https://api.github.com/repos/jeancochrane/tfjs-core/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/jeancochrane/tfjs-core/downloads","issues_url":"https://api.github.com/repos/jeancochrane/tfjs-core/issues{/number}","pulls_url":"https://api.github.com/repos/jeancochrane/tfjs-core/pulls{/number}","milestones_url":"https://api.github.com/repos/jeancochrane/tfjs-core/milestones{/number}","notifications_url":"https://api.github.com/repos/jeancochrane/tfjs-core/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/jeancochrane/tfjs-core/labels{/name}","releases_url":"https://api.github.com/repos/jeancochrane/tfjs-core/releases{/id}","deployments_url":"https://api.github.com/repos/jeancochrane/tfjs-core/deployments","created_at":"2018-10-31T14:39:08Z","updated_at":"2018-10-31T14:39:11Z","pushed_at":"2018-10-31T19:20:17Z","git_url":"git://github.com/jeancochrane/tfjs-core.git","ssh_url":"git@github.com:jeancochrane/tfjs-core.git","clone_url":"https://github.com/jeancochrane/tfjs-core.git","svn_url":"https://github.com/jeancochrane/tfjs-core","homepage":"https://js.tensorflow.org","size":62875,"stargazers_count":0,"watchers_count":0,"language":"TypeScript","has_issues":false,"has_projects":true,"has_downloads":true,"has_wiki":false,"has_pages":false,"forks_count":0,"mirror_url":null,"archived":false,"open_issues_count":0,"license":{"key":"apache-2.0","name":"Apache License 2.0","spdx_id":"Apache-2.0","url":"https://api.github.com/licenses/apache-2.0","node_id":"MDc6TGljZW5zZTI="},"forks":0,"open_issues":0,"watchers":0,"default_branch":"master"}},"base":{"label":"tensorflow:master","ref":"master","sha":"6dead841829062170927e419166e4f76dafc1e2f","user":{"login":"tensorflow","id":15658638,"node_id":"MDEyOk9yZ2FuaXphdGlvbjE1NjU4NjM4","avatar_url":"https://avatars1.githubusercontent.com/u/15658638?v=4","gravatar_id":"","url":"https://api.github.com/users/tensorflow","html_url":"https://github.com/tensorflow","followers_url":"https://api.github.com/users/tensorflow/followers","following_url":"https://api.github.com/users/tensorflow/following{/other_user}","gists_url":"https://api.github.com/users/tensorflow/gists{/gist_id}","starred_url":"https://api.github.com/users/tensorflow/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/tensorflow/subscriptions","organizations_url":"https://api.github.com/users/tensorflow/orgs","repos_url":"https://api.github.com/users/tensorflow/repos","events_url":"https://api.github.com/users/tensorflow/events{/privacy}","received_events_url":"https://api.github.com/users/tensorflow/received_events","type":"Organization","site_admin":false},"repo":{"id":99127696,"node_id":"MDEwOlJlcG9zaXRvcnk5OTEyNzY5Ng==","name":"tfjs-core","full_name":"tensorflow/tfjs-core","private":false,"owner":{"login":"tensorflow","id":15658638,"node_id":"MDEyOk9yZ2FuaXphdGlvbjE1NjU4NjM4","avatar_url":"https://avatars1.githubusercontent.com/u/15658638?v=4","gravatar_id":"","url":"https://api.github.com/users/tensorflow","html_url":"https://github.com/tensorflow","followers_url":"https://api.github.com/users/tensorflow/followers","following_url":"https://api.github.com/users/tensorflow/following{/other_user}","gists_url":"https://api.github.com/users/tensorflow/gists{/gist_id}","starred_url":"https://api.github.com/users/tensorflow/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/tensorflow/subscriptions","organizations_url":"https://api.github.com/users/tensorflow/orgs","repos_url":"https://api.github.com/users/tensorflow/repos","events_url":"https://api.github.com/users/tensorflow/events{/privacy}","received_events_url":"https://api.github.com/users/tensorflow/received_events","type":"Organization","site_admin":false},"html_url":"https://github.com/tensorflow/tfjs-core","description":"WebGL-accelerated ML // linear algebra // automatic differentiation for JavaScript.","fork":false,"url":"https://api.github.com/repos/tensorflow/tfjs-core","forks_url":"https://api.github.com/repos/tensorflow/tfjs-core/forks","keys_url":"https://api.github.com/repos/tensorflow/tfjs-core/keys{/key_id}","collaborators_url":"https://api.github.com/repos/tensorflow/tfjs-core/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/tensorflow/tfjs-core/teams","hooks_url":"https://api.github.com/repos/tensorflow/tfjs-core/hooks","issue_events_url":"https://api.github.com/repos/tensorflow/tfjs-core/issues/events{/number}","events_url":"https://api.github.com/repos/tensorflow/tfjs-core/events","assignees_url":"https://api.github.com/repos/tensorflow/tfjs-core/assignees{/user}","branches_url":"https://api.github.com/repos/tensorflow/tfjs-core/branches{/branch}","tags_url":"https://api.github.com/repos/tensorflow/tfjs-core/tags","blobs_url":"https://api.github.com/repos/tensorflow/tfjs-core/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/tensorflow/tfjs-core/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/tensorflow/tfjs-core/git/refs{/sha}","trees_url":"https://api.github.com/repos/tensorflow/tfjs-core/git/trees{/sha}","statuses_url":"https://api.github.com/repos/tensorflow/tfjs-core/statuses/{sha}","languages_url":"https://api.github.com/repos/tensorflow/tfjs-core/languages","stargazers_url":"https://api.github.com/repos/tensorflow/tfjs-core/stargazers","contributors_url":"https://api.github.com/repos/tensorflow/tfjs-core/contributors","subscribers_url":"https://api.github.com/repos/tensorflow/tfjs-core/subscribers","subscription_url":"https://api.github.com/repos/tensorflow/tfjs-core/subscription","commits_url":"https://api.github.com/repos/tensorflow/tfjs-core/commits{/sha}","git_commits_url":"https://api.github.com/repos/tensorflow/tfjs-core/git/commits{/sha}","comments_url":"https://api.github.com/repos/tensorflow/tfjs-core/comments{/number}","issue_comment_url":"https://api.github.com/repos/tensorflow/tfjs-core/issues/comments{/number}","contents_url":"https://api.github.com/repos/tensorflow/tfjs-core/contents/{+path}","compare_url":"https://api.github.com/repos/tensorflow/tfjs-core/compare/{base}...{head}","merges_url":"https://api.github.com/repos/tensorflow/tfjs-core/merges","archive_url":"https://api.github.com/repos/tensorflow/tfjs-core/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/tensorflow/tfjs-core/downloads","issues_url":"https://api.github.com/repos/tensorflow/tfjs-core/issues{/number}","pulls_url":"https://api.github.com/repos/tensorflow/tfjs-core/pulls{/number}","milestones_url":"https://api.github.com/repos/tensorflow/tfjs-core/milestones{/number}","notifications_url":"https://api.github.com/repos/tensorflow/tfjs-core/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/tensorflow/tfjs-core/labels{/name}","releases_url":"https://api.github.com/repos/tensorflow/tfjs-core/releases{/id}","deployments_url":"https://api.github.com/repos/tensorflow/tfjs-core/deployments","created_at":"2017-08-02T14:45:47Z","updated_at":"2018-11-08T16:57:27Z","pushed_at":"2018-11-08T18:10:33Z","git_url":"git://github.com/tensorflow/tfjs-core.git","ssh_url":"git@github.com:tensorflow/tfjs-core.git","clone_url":"https://github.com/tensorflow/tfjs-core.git","svn_url":"https://github.com/tensorflow/tfjs-core","homepage":"https://js.tensorflow.org","size":361202,"stargazers_count":8109,"watchers_count":8109,"language":"TypeScript","has_issues":false,"has_projects":false,"has_downloads":true,"has_wiki":false,"has_pages":false,"forks_count":867,"mirror_url":null,"archived":false,"open_issues_count":21,"license":{"key":"apache-2.0","name":"Apache License 2.0","spdx_id":"Apache-2.0","url":"https://api.github.com/licenses/apache-2.0","node_id":"MDc6TGljZW5zZTI="},"forks":867,"open_issues":21,"watchers":8109,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/tensorflow/tfjs-core/pulls/1368"},"html":{"href":"https://github.com/tensorflow/tfjs-core/pull/1368"},"issue":{"href":"https://api.github.com/repos/tensorflow/tfjs-core/issues/1368"},"comments":{"href":"https://api.github.com/repos/tensorflow/tfjs-core/issues/1368/comments"},"review_comments":{"href":"https://api.github.com/repos/tensorflow/tfjs-core/pulls/1368/comments"},"review_comment":{"href":"https://api.github.com/repos/tensorflow/tfjs-core/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/tensorflow/tfjs-core/pulls/1368/commits"},"statuses":{"href":"https://api.github.com/repos/tensorflow/tfjs-core/statuses/462646c1d09041396bcb803351145a2a14d81904"}},"author_association":"NONE","merged":true,"mergeable":null,"rebaseable":null,"mergeable_state":"unknown","merged_by":{"login":"nsthorat","id":1100749,"node_id":"MDQ6VXNlcjExMDA3NDk=","avatar_url":"https://avatars0.githubusercontent.com/u/1100749?v=4","gravatar_id":"","url":"https://api.github.com/users/nsthorat","html_url":"https://github.com/nsthorat","followers_url":"https://api.github.com/users/nsthorat/followers","following_url":"https://api.github.com/users/nsthorat/following{/other_user}","gists_url":"https://api.github.com/users/nsthorat/gists{/gist_id}","starred_url":"https://api.github.com/users/nsthorat/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/nsthorat/subscriptions","organizations_url":"https://api.github.com/users/nsthorat/orgs","repos_url":"https://api.github.com/users/nsthorat/repos","events_url":"https://api.github.com/users/nsthorat/events{/privacy}","received_events_url":"https://api.github.com/users/nsthorat/received_events","type":"User","site_admin":false},"comments":4,"review_comments":0,"maintainer_can_modify":false,"commits":1,"additions":2,"deletions":0,"changed_files":1}}
{"actor":{"display_login":"nsthorat"}}