Repository navigation
docs: recommend several example URLs of one page type for prepare_domain() - #68
Merged
Merged
Conversation
…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.
…wording Say "we recommend 3 or more of the same page type" instead of "at least 3 pages of each page type", in the prepare_domain() docstring and the README's "Preparing a domain" section. One URL still works; no behaviour change.
jonathan-zenrows
marked this pull request as ready for review
October 27, 2026 07:08
jonathan-zenrows
approved these changes
Oct 27, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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.example_urlstakes 1 to 5 example URLs. One works.Why
Extract compares pages of one type to check the fields it found and fill in fields one page is missing.
Not changed
No behaviour change:
example_urlsstill 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): passmake test: 304 passed, 1 deselected (e2e)