Skip to content

docs: recommend several example URLs of one page type for prepare_domain() - #68

Draft
zenrows-dev-pool[bot] wants to merge 1 commit into
mainfrom
feat/extract-example-urls-guidance
Draft

zenrows-dev-pool[bot] wants to merge 1 commit into
mainfrom
feat/extract-example-urls-guidance

Conversation

@zenrows-dev-pool

Copy link
Copy Markdown
Contributor

What

Docs only: the prepare_domain() docstring and the README's "Preparing a domain" section now steer callers to send several example URLs of the same page type.

  • One example URL still works.
  • Recommended: at least 3 pages of each page type you need extracted, up to 5 in total. Several page types can share the 5, for example 3 product pages and 2 search-result pages.
  • The README example now passes three product pages from the same domain instead of one listing URL.
  • The old wording "one per kind of page you want to extract" is gone, since it told users to send one URL per type.

Why

Extract compares the pages of one type against each other, so it can check the fields it found and fill in fields that one page is missing. More pages of a type give more complete, more reliable results for that type.

Not changed

No behaviour change: example_urls still accepts 1 to 5 URLs, and the client does not reject or warn on 1 or 2 URLs.

Checks

  • make check (ty, ruff check, ruff format --check): pass
  • make test: 304 passed, 1 deselected (e2e)

…ain()

One example URL still works, but Extract compares the pages of one page
type against each other, so several related URLs (at least 3 of a type,
up to 5) give more complete, more reliable results. Replace the old
"one per kind of page" wording, which suggested the opposite, and show
three product pages in the README example. No behaviour change.

This branch has not been deployed

No deployments
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.

0 participants