chore: Fix sitemap_urls description in SitemapRequestLoader#2026
Merged
vdusek merged 1 commit intoJul 6, 2026
Conversation
The sitemap_urls parameter in SitemapRequestLoader.__init__ was documented as 'Configuration options for the loader.', a copy-paste placeholder that does not describe the argument. It is the list of sitemap URLs the loader fetches and parses for request URLs.
vdusek
approved these changes
Jul 6, 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.
The
sitemap_urlsparameter ofSitemapRequestLoader.__init__is documented as"Configuration options for the loader.", a copy-paste placeholder that does not
describe the argument.
sitemap_urls: list[str]is the list of sitemap URLs theloader fetches and parses for request URLs.
This corrects the one-line docstring to match the class docstring ("The loader
fetches and parses sitemaps in the background"), the internal state field
("Queue of sitemap URLs that need to be fetched and processed"), and every docs
example (all pass a list such as
sitemap_urls=['https://crawlee.dev/sitemap.xml']).Docs-only change; no source or behavior change.
Issues
Testing
uv run poe lintpasses (ruff format check + ruff check).uv run poe type-check(ty) reports no new diagnostics; the changed file isunaffected.
Checklist
Notes for the ship step (not part of the PR)
gh pr create --repo apify/crawlee-python --base master \ --head anxkhn:docs/fix-sitemap-urls-param-description \ --title "docs: fix sitemap_urls parameter description in SitemapRequestLoader" \ --body-file <clean body>self-identified docstring fix with no tracking issue (the repo has no
good first issuelabel and issues are maintainer-assigned).