Skip to content

chore: Fix sitemap_urls description in SitemapRequestLoader#2026

Merged
vdusek merged 1 commit into
apify:masterfrom
anxkhn:docs/fix-sitemap-urls-param-description
Jul 6, 2026
Merged

chore: Fix sitemap_urls description in SitemapRequestLoader#2026
vdusek merged 1 commit into
apify:masterfrom
anxkhn:docs/fix-sitemap-urls-param-description

Conversation

@anxkhn

@anxkhn anxkhn commented Jul 6, 2026

Copy link
Copy Markdown
Contributor

The sitemap_urls parameter of SitemapRequestLoader.__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 the
loader 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']).

-            sitemap_urls: Configuration options for the loader.
+            sitemap_urls: List of sitemap URLs to fetch and parse for request URLs.

Docs-only change; no source or behavior change.

Issues

  • No related issue.

Testing

  • Documentation-only change, so no runtime behavior to test.
  • uv run poe lint passes (ruff format check + ruff check).
  • uv run poe type-check (ty) reports no new diagnostics; the changed file is
    unaffected.

Checklist

  • CI passed

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>
  • The "Issues" line intentionally does not use "Closes: #NNN": this is a
    self-identified docstring fix with no tracking issue (the repo has no
    good first issue label and issues are maintainer-assigned).
  • No DCO sign-off and no CLA are required by this repo.

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 vdusek changed the title docs: fix sitemap_urls parameter description in SitemapRequestLoader chore: Fix sitemap_urls description in SitemapRequestLoader Jul 6, 2026
@vdusek vdusek merged commit 1d26fa7 into apify:master Jul 6, 2026
35 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.

3 participants