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

Initial docs #9

Merged
merged 20 commits into from
Nov 3, 2023
Merged

Initial docs #9

merged 20 commits into from
Nov 3, 2023

Conversation

Gallaecio
Copy link
Contributor

No description provided.

Comment on lines +20 to +21
"""Follow most links within the domain of URL in an attempt to discover and
extract as many products as possible."""
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tried to use Foo.bar.__doc__ in enumMeta to avoid duplication, but the __doc__ is not generated at regular run time (there’s some “interactive” condition in the decorator implementation), and this way we can potentially provide more details in the reference docs than those we want in enumMeta; maybe we could even make enumMeta provide a link to the upstream reference for details where needed.


* ``EcommerceSpider``: a spider that can scrape products from any e-commerce
website.
* Documentation: https://zyte-spider-templates.readthedocs.io/en/latest/
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤞 No one steals it.

zyte_spider_templates/spiders/base.py Outdated Show resolved Hide resolved
zyte_spider_templates/spiders/ecommerce.py Show resolved Hide resolved
docs/setup.rst Outdated Show resolved Hide resolved
docs/templates/e-commerce.rst Show resolved Hide resolved

.. autoenum:: zyte_spider_templates.spiders.ecommerce.EcommerceCrawlStrategy

.. autoenum:: zyte_spider_templates.spiders.ecommerce.ExtractFrom
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We need a more descriptive text for this one. The same case with Geolocation.

image

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In my rendering, I do not get “An enumeration.”, but rather nothing at all. Which I think is fine given the parameter descriptions themselves at the top. No strong opinion, though.

docs/customization/page-objects.rst Outdated Show resolved Hide resolved
@codecov-commenter
Copy link

codecov-commenter commented Nov 2, 2023

Codecov Report

Merging #9 (e495926) into main (d1a5bbd) will increase coverage by 0.47%.
The diff coverage is 86.36%.

❗ Current head e495926 differs from pull request most recent head 173dd55. Consider uploading reports for the commit 173dd55 to get more accurate results

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@            Coverage Diff             @@
##             main       #9      +/-   ##
==========================================
+ Coverage   98.08%   98.56%   +0.47%     
==========================================
  Files           8        9       +1     
  Lines         471      488      +17     
==========================================
+ Hits          462      481      +19     
+ Misses          9        7       -2     
Files Coverage Δ
zyte_spider_templates/documentation.py 100.00% <100.00%> (ø)
zyte_spider_templates/spiders/ecommerce.py 96.42% <100.00%> (+0.59%) ⬆️
zyte_spider_templates/middlewares.py 88.63% <66.66%> (+6.13%) ⬆️

docs/setup.rst Show resolved Hide resolved
@Gallaecio Gallaecio merged commit 13f45c7 into zytedata:main Nov 3, 2023
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants