{"action":"created","comment":{"url":"https://api.github.com/repos/scrapy/scrapy/pulls/comments/29167002","id":29167002,"diff_hunk":"@@ -123,17 +161,43 @@ def _setup_crawler_logging(self, crawler):\n             crawler.signals.connect(log_observer.stop, signals.engine_stopped)\n \n     def stop(self):\n+        \"\"\"\n+        Stops simultaneously all the crawling jobs taking place.\n+\n+        Returns a deferred that is fired when they all have ended.\n+        \"\"\"\n         return defer.DeferredList([c.stop() for c in list(self.crawlers)])\n \n     @defer.inlineCallbacks\n     def join(self):\n-        \"\"\"Wait for all managed crawlers to complete\"\"\"\n+        \"\"\"\n+        join()","path":"scrapy/crawler.py","position":75,"original_position":75,"commit_id":"79080b23a927480749f3951bf71a053719e00261","original_commit_id":"79080b23a927480749f3951bf71a053719e00261","user":{"login":"kmike","id":107893,"avatar_url":"https://avatars.githubusercontent.com/u/107893?v=3","gravatar_id":"","url":"https://api.github.com/users/kmike","html_url":"https://github.com/kmike","followers_url":"https://api.github.com/users/kmike/followers","following_url":"https://api.github.com/users/kmike/following{/other_user}","gists_url":"https://api.github.com/users/kmike/gists{/gist_id}","starred_url":"https://api.github.com/users/kmike/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/kmike/subscriptions","organizations_url":"https://api.github.com/users/kmike/orgs","repos_url":"https://api.github.com/users/kmike/repos","events_url":"https://api.github.com/users/kmike/events{/privacy}","received_events_url":"https://api.github.com/users/kmike/received_events","type":"User","site_admin":false},"body":"you can write a signature in the docs itself, see http://sphinx-doc.org/ext/autodoc.html#directive-automethod","created_at":"2015-04-27T17:07:40Z","updated_at":"2015-04-27T17:07:40Z","html_url":"https://github.com/scrapy/scrapy/pull/1190#discussion_r29167002","pull_request_url":"https://api.github.com/repos/scrapy/scrapy/pulls/1190","_links":{"self":{"href":"https://api.github.com/repos/scrapy/scrapy/pulls/comments/29167002"},"html":{"href":"https://github.com/scrapy/scrapy/pull/1190#discussion_r29167002"},"pull_request":{"href":"https://api.github.com/repos/scrapy/scrapy/pulls/1190"}}},"pull_request":{"url":"https://api.github.com/repos/scrapy/scrapy/pulls/1190","id":34187525,"html_url":"https://github.com/scrapy/scrapy/pull/1190","diff_url":"https://github.com/scrapy/scrapy/pull/1190.diff","patch_url":"https://github.com/scrapy/scrapy/pull/1190.patch","issue_url":"https://api.github.com/repos/scrapy/scrapy/issues/1190","number":1190,"state":"open","locked":false,"title":"CrawlerProcess documentation","user":{"login":"Curita","id":213781,"avatar_url":"https://avatars.githubusercontent.com/u/213781?v=3","gravatar_id":"","url":"https://api.github.com/users/Curita","html_url":"https://github.com/Curita","followers_url":"https://api.github.com/users/Curita/followers","following_url":"https://api.github.com/users/Curita/following{/other_user}","gists_url":"https://api.github.com/users/Curita/gists{/gist_id}","starred_url":"https://api.github.com/users/Curita/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/Curita/subscriptions","organizations_url":"https://api.github.com/users/Curita/orgs","repos_url":"https://api.github.com/users/Curita/repos","events_url":"https://api.github.com/users/Curita/events{/privacy}","received_events_url":"https://api.github.com/users/Curita/received_events","type":"User","site_admin":false},"body":"As discussed in #1146, CrawlerProcess is generally a better fit than CrawlerRunner for scripting (see #1001 for example), so I made a couple of changes to reflect that in the documentation.\r\n\r\nChanges made in this PR:\r\n* Use Sphinx autodocs for CrawlerRunner so CrawlerProcess doesn't need to document again the inherited methods\r\n* Document CrawlerProcess\r\n* Add CrawlerProcess examples to \"Run Scrapy from a script\"\r\n* Favor CrawlerProcess over CrawlerRunner in the \"Run Scrapy from a script\" section","created_at":"2015-04-27T16:46:56Z","updated_at":"2015-04-27T17:07:40Z","closed_at":null,"merged_at":null,"merge_commit_sha":"492f37c80676b885cdcf7abbdb8bd70d0b6e6b24","assignee":null,"milestone":{"url":"https://api.github.com/repos/scrapy/scrapy/milestones/6","html_url":"https://github.com/scrapy/scrapy/milestones/Scrapy%201.0","labels_url":"https://api.github.com/repos/scrapy/scrapy/milestones/6/labels","id":914091,"number":6,"title":"Scrapy 1.0","description":"","creator":{"login":"kmike","id":107893,"avatar_url":"https://avatars.githubusercontent.com/u/107893?v=3","gravatar_id":"","url":"https://api.github.com/users/kmike","html_url":"https://github.com/kmike","followers_url":"https://api.github.com/users/kmike/followers","following_url":"https://api.github.com/users/kmike/following{/other_user}","gists_url":"https://api.github.com/users/kmike/gists{/gist_id}","starred_url":"https://api.github.com/users/kmike/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/kmike/subscriptions","organizations_url":"https://api.github.com/users/kmike/orgs","repos_url":"https://api.github.com/users/kmike/repos","events_url":"https://api.github.com/users/kmike/events{/privacy}","received_events_url":"https://api.github.com/users/kmike/received_events","type":"User","site_admin":false},"open_issues":8,"closed_issues":22,"state":"open","created_at":"2014-12-24T09:57:08Z","updated_at":"2015-04-27T16:46:56Z","due_on":null,"closed_at":null},"commits_url":"https://api.github.com/repos/scrapy/scrapy/pulls/1190/commits","review_comments_url":"https://api.github.com/repos/scrapy/scrapy/pulls/1190/comments","review_comment_url":"https://api.github.com/repos/scrapy/scrapy/pulls/comments{/number}","comments_url":"https://api.github.com/repos/scrapy/scrapy/issues/1190/comments","statuses_url":"https://api.github.com/repos/scrapy/scrapy/statuses/79080b23a927480749f3951bf71a053719e00261","head":{"label":"Curita:crawlerprocess-docs","ref":"crawlerprocess-docs","sha":"79080b23a927480749f3951bf71a053719e00261","user":{"login":"Curita","id":213781,"avatar_url":"https://avatars.githubusercontent.com/u/213781?v=3","gravatar_id":"","url":"https://api.github.com/users/Curita","html_url":"https://github.com/Curita","followers_url":"https://api.github.com/users/Curita/followers","following_url":"https://api.github.com/users/Curita/following{/other_user}","gists_url":"https://api.github.com/users/Curita/gists{/gist_id}","starred_url":"https://api.github.com/users/Curita/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/Curita/subscriptions","organizations_url":"https://api.github.com/users/Curita/orgs","repos_url":"https://api.github.com/users/Curita/repos","events_url":"https://api.github.com/users/Curita/events{/privacy}","received_events_url":"https://api.github.com/users/Curita/received_events","type":"User","site_admin":false},"repo":{"id":17608525,"name":"scrapy","full_name":"Curita/scrapy","owner":{"login":"Curita","id":213781,"avatar_url":"https://avatars.githubusercontent.com/u/213781?v=3","gravatar_id":"","url":"https://api.github.com/users/Curita","html_url":"https://github.com/Curita","followers_url":"https://api.github.com/users/Curita/followers","following_url":"https://api.github.com/users/Curita/following{/other_user}","gists_url":"https://api.github.com/users/Curita/gists{/gist_id}","starred_url":"https://api.github.com/users/Curita/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/Curita/subscriptions","organizations_url":"https://api.github.com/users/Curita/orgs","repos_url":"https://api.github.com/users/Curita/repos","events_url":"https://api.github.com/users/Curita/events{/privacy}","received_events_url":"https://api.github.com/users/Curita/received_events","type":"User","site_admin":false},"private":false,"html_url":"https://github.com/Curita/scrapy","description":"Scrapy, a fast high-level screen scraping and web crawling framework for Python.","fork":true,"url":"https://api.github.com/repos/Curita/scrapy","forks_url":"https://api.github.com/repos/Curita/scrapy/forks","keys_url":"https://api.github.com/repos/Curita/scrapy/keys{/key_id}","collaborators_url":"https://api.github.com/repos/Curita/scrapy/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/Curita/scrapy/teams","hooks_url":"https://api.github.com/repos/Curita/scrapy/hooks","issue_events_url":"https://api.github.com/repos/Curita/scrapy/issues/events{/number}","events_url":"https://api.github.com/repos/Curita/scrapy/events","assignees_url":"https://api.github.com/repos/Curita/scrapy/assignees{/user}","branches_url":"https://api.github.com/repos/Curita/scrapy/branches{/branch}","tags_url":"https://api.github.com/repos/Curita/scrapy/tags","blobs_url":"https://api.github.com/repos/Curita/scrapy/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/Curita/scrapy/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/Curita/scrapy/git/refs{/sha}","trees_url":"https://api.github.com/repos/Curita/scrapy/git/trees{/sha}","statuses_url":"https://api.github.com/repos/Curita/scrapy/statuses/{sha}","languages_url":"https://api.github.com/repos/Curita/scrapy/languages","stargazers_url":"https://api.github.com/repos/Curita/scrapy/stargazers","contributors_url":"https://api.github.com/repos/Curita/scrapy/contributors","subscribers_url":"https://api.github.com/repos/Curita/scrapy/subscribers","subscription_url":"https://api.github.com/repos/Curita/scrapy/subscription","commits_url":"https://api.github.com/repos/Curita/scrapy/commits{/sha}","git_commits_url":"https://api.github.com/repos/Curita/scrapy/git/commits{/sha}","comments_url":"https://api.github.com/repos/Curita/scrapy/comments{/number}","issue_comment_url":"https://api.github.com/repos/Curita/scrapy/issues/comments{/number}","contents_url":"https://api.github.com/repos/Curita/scrapy/contents/{+path}","compare_url":"https://api.github.com/repos/Curita/scrapy/compare/{base}...{head}","merges_url":"https://api.github.com/repos/Curita/scrapy/merges","archive_url":"https://api.github.com/repos/Curita/scrapy/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/Curita/scrapy/downloads","issues_url":"https://api.github.com/repos/Curita/scrapy/issues{/number}","pulls_url":"https://api.github.com/repos/Curita/scrapy/pulls{/number}","milestones_url":"https://api.github.com/repos/Curita/scrapy/milestones{/number}","notifications_url":"https://api.github.com/repos/Curita/scrapy/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/Curita/scrapy/labels{/name}","releases_url":"https://api.github.com/repos/Curita/scrapy/releases{/id}","created_at":"2014-03-10T21:06:20Z","updated_at":"2015-03-10T19:07:47Z","pushed_at":"2015-04-27T15:51:51Z","git_url":"git://github.com/Curita/scrapy.git","ssh_url":"git@github.com:Curita/scrapy.git","clone_url":"https://github.com/Curita/scrapy.git","svn_url":"https://github.com/Curita/scrapy","homepage":"http://scrapy.org","size":14293,"stargazers_count":0,"watchers_count":0,"language":"Python","has_issues":false,"has_downloads":false,"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":"scrapy:master","ref":"master","sha":"fa1039f5b27162a02dbcc8ef4de7fa07ca36a51c","user":{"login":"scrapy","id":733635,"avatar_url":"https://avatars.githubusercontent.com/u/733635?v=3","gravatar_id":"","url":"https://api.github.com/users/scrapy","html_url":"https://github.com/scrapy","followers_url":"https://api.github.com/users/scrapy/followers","following_url":"https://api.github.com/users/scrapy/following{/other_user}","gists_url":"https://api.github.com/users/scrapy/gists{/gist_id}","starred_url":"https://api.github.com/users/scrapy/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/scrapy/subscriptions","organizations_url":"https://api.github.com/users/scrapy/orgs","repos_url":"https://api.github.com/users/scrapy/repos","events_url":"https://api.github.com/users/scrapy/events{/privacy}","received_events_url":"https://api.github.com/users/scrapy/received_events","type":"Organization","site_admin":false},"repo":{"id":529502,"name":"scrapy","full_name":"scrapy/scrapy","owner":{"login":"scrapy","id":733635,"avatar_url":"https://avatars.githubusercontent.com/u/733635?v=3","gravatar_id":"","url":"https://api.github.com/users/scrapy","html_url":"https://github.com/scrapy","followers_url":"https://api.github.com/users/scrapy/followers","following_url":"https://api.github.com/users/scrapy/following{/other_user}","gists_url":"https://api.github.com/users/scrapy/gists{/gist_id}","starred_url":"https://api.github.com/users/scrapy/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/scrapy/subscriptions","organizations_url":"https://api.github.com/users/scrapy/orgs","repos_url":"https://api.github.com/users/scrapy/repos","events_url":"https://api.github.com/users/scrapy/events{/privacy}","received_events_url":"https://api.github.com/users/scrapy/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/scrapy/scrapy","description":"Scrapy, a fast high-level web crawling and screen scraping framework for Python.","fork":false,"url":"https://api.github.com/repos/scrapy/scrapy","forks_url":"https://api.github.com/repos/scrapy/scrapy/forks","keys_url":"https://api.github.com/repos/scrapy/scrapy/keys{/key_id}","collaborators_url":"https://api.github.com/repos/scrapy/scrapy/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/scrapy/scrapy/teams","hooks_url":"https://api.github.com/repos/scrapy/scrapy/hooks","issue_events_url":"https://api.github.com/repos/scrapy/scrapy/issues/events{/number}","events_url":"https://api.github.com/repos/scrapy/scrapy/events","assignees_url":"https://api.github.com/repos/scrapy/scrapy/assignees{/user}","branches_url":"https://api.github.com/repos/scrapy/scrapy/branches{/branch}","tags_url":"https://api.github.com/repos/scrapy/scrapy/tags","blobs_url":"https://api.github.com/repos/scrapy/scrapy/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/scrapy/scrapy/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/scrapy/scrapy/git/refs{/sha}","trees_url":"https://api.github.com/repos/scrapy/scrapy/git/trees{/sha}","statuses_url":"https://api.github.com/repos/scrapy/scrapy/statuses/{sha}","languages_url":"https://api.github.com/repos/scrapy/scrapy/languages","stargazers_url":"https://api.github.com/repos/scrapy/scrapy/stargazers","contributors_url":"https://api.github.com/repos/scrapy/scrapy/contributors","subscribers_url":"https://api.github.com/repos/scrapy/scrapy/subscribers","subscription_url":"https://api.github.com/repos/scrapy/scrapy/subscription","commits_url":"https://api.github.com/repos/scrapy/scrapy/commits{/sha}","git_commits_url":"https://api.github.com/repos/scrapy/scrapy/git/commits{/sha}","comments_url":"https://api.github.com/repos/scrapy/scrapy/comments{/number}","issue_comment_url":"https://api.github.com/repos/scrapy/scrapy/issues/comments{/number}","contents_url":"https://api.github.com/repos/scrapy/scrapy/contents/{+path}","compare_url":"https://api.github.com/repos/scrapy/scrapy/compare/{base}...{head}","merges_url":"https://api.github.com/repos/scrapy/scrapy/merges","archive_url":"https://api.github.com/repos/scrapy/scrapy/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/scrapy/scrapy/downloads","issues_url":"https://api.github.com/repos/scrapy/scrapy/issues{/number}","pulls_url":"https://api.github.com/repos/scrapy/scrapy/pulls{/number}","milestones_url":"https://api.github.com/repos/scrapy/scrapy/milestones{/number}","notifications_url":"https://api.github.com/repos/scrapy/scrapy/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/scrapy/scrapy/labels{/name}","releases_url":"https://api.github.com/repos/scrapy/scrapy/releases{/id}","created_at":"2010-02-22T02:01:14Z","updated_at":"2015-04-27T16:30:52Z","pushed_at":"2015-04-27T16:46:57Z","git_url":"git://github.com/scrapy/scrapy.git","ssh_url":"git@github.com:scrapy/scrapy.git","clone_url":"https://github.com/scrapy/scrapy.git","svn_url":"https://github.com/scrapy/scrapy","homepage":"http://scrapy.org","size":25871,"stargazers_count":8426,"watchers_count":8426,"language":"Python","has_issues":true,"has_downloads":false,"has_wiki":true,"has_pages":false,"forks_count":2378,"mirror_url":null,"open_issues_count":247,"forks":2378,"open_issues":247,"watchers":8426,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/scrapy/scrapy/pulls/1190"},"html":{"href":"https://github.com/scrapy/scrapy/pull/1190"},"issue":{"href":"https://api.github.com/repos/scrapy/scrapy/issues/1190"},"comments":{"href":"https://api.github.com/repos/scrapy/scrapy/issues/1190/comments"},"review_comments":{"href":"https://api.github.com/repos/scrapy/scrapy/pulls/1190/comments"},"review_comment":{"href":"https://api.github.com/repos/scrapy/scrapy/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/scrapy/scrapy/pulls/1190/commits"},"statuses":{"href":"https://api.github.com/repos/scrapy/scrapy/statuses/79080b23a927480749f3951bf71a053719e00261"}}}}