Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[MRG+1] doc: update configure_logging docs to discourage use with CrawlerProcess #3762

Merged
merged 1 commit into from May 9, 2019

Conversation

@Vandenn
Copy link
Contributor

@Vandenn Vandenn commented May 2, 2019

Update to the configure_logging docs in order to prevent users from using this function with CrawlerProcess as this produces unexpected behavior.

Fixes #1347

@codecov
Copy link

@codecov codecov bot commented May 2, 2019

Codecov Report

Merging #3762 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master    #3762   +/-   ##
=======================================
  Coverage   85.42%   85.42%           
=======================================
  Files         169      169           
  Lines        9635     9635           
  Branches     1433     1433           
=======================================
  Hits         8231     8231           
  Misses       1156     1156           
  Partials      248      248

Copy link
Member

@Gallaecio Gallaecio left a comment

I think this can be made shorter and more clear simply changing:

``configure_logging`` is automatically called when using Scrapy commands,
but needs to be called explicitly when running custom scripts.

to

``configure_logging`` is automatically called when using Scrapy commands or
:class:`~scrapy.crawler.CrawlerProcess`, but needs to be called explicitly when
using :class:`~scrapy.crawler.CrawlerRunner`.

@Vandenn Vandenn force-pushed the update-logging-docs branch from ea96a2c to 65d7780 May 3, 2019
@Vandenn
Copy link
Contributor Author

@Vandenn Vandenn commented May 3, 2019

I've updated the commit based on your suggestion. Kindly review the changes. Thanks!

docs/topics/logging.rst Outdated Show resolved Hide resolved
@Vandenn Vandenn force-pushed the update-logging-docs branch from 65d7780 to 122ca62 May 3, 2019
@Gallaecio Gallaecio changed the title doc: update configure_logging docs to discourage use with CrawlerProcess [MRG+1] doc: update configure_logging docs to discourage use with CrawlerProcess May 3, 2019
@Gallaecio Gallaecio added the docs label May 3, 2019
@Gallaecio
Copy link
Member

@Gallaecio Gallaecio commented May 3, 2019

Great, thanks!

@kmike kmike merged commit 137a3d8 into scrapy:master May 9, 2019
3 checks passed
@Vandenn Vandenn deleted the update-logging-docs branch May 9, 2019
@kmike kmike added this to the v1.7 milestone Jun 25, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

3 participants