[MRG+1] Improve docs of S3 Storage to make Python version more explicit #3294
Conversation
Codecov Report
@@ Coverage Diff @@
## master #3294 +/- ##
=======================================
Coverage 82.14% 82.14%
=======================================
Files 228 228
Lines 9599 9599
Branches 1385 1385
=======================================
Hits 7885 7885
Misses 1456 1456
Partials 258 258 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
The documentation of the S3 storage backend (https://doc.scrapy.org/en/latest/topics/feed-exports.html#s3) suggest the use of the libraries botocore (https://github.com/boto/botocore) or boto (https://github.com/boto/boto). However, boto library will work only if the user is using Python 2 (as it is correctly explained here https://doc.scrapy.org/en/latest/topics/feed-exports.html#storages).
Besides the fact of this information is there, I believe that it would be better for the user reading the documentation to have this note also inside the specific section of S3 storage backend.
When issue #1866 is resolved, this could be removed anyway.