Skip to content

Document SoundCloud async JS limitation - #134

Merged
vedaant00 merged 1 commit into
mldsveda:mainfrom
kocaemre:fix/soundcloud-async-docs
Aug 10, 2026
Merged

Document SoundCloud async JS limitation#134
vedaant00 merged 1 commit into
mldsveda:mainfrom
kocaemre:fix/soundcloud-async-docs

Conversation

@kocaemre

Copy link
Copy Markdown
Contributor

Summary

  • Remove the incorrect "same args/returns" wording from SoundCloudScraper.scrape_async.
  • Document that the async SoundCloud path is HTTP-only and does not support render_js/scroll_pages.
  • Add a regression guard for the async docstring so the limitation stays explicit.

Verification

  • RED: python -m pytest tests/test_scrapers/test_music.py::TestSoundCloudScraper::test_async_docstring_documents_http_only_limitation -q failed because the docstring still claimed parity.
  • GREEN: python -m pytest tests/test_scrapers/test_music.py::TestSoundCloudScraper -q
  • python -m pytest tests/ -q
  • ruff check src/ tests/

Fixes #130.

Signed-off-by: Emre K <110906681+kocaemre@users.noreply.github.com>
@vedaant00
vedaant00 merged commit 9e1042c into mldsveda:main Aug 10, 2026
6 checks passed
@vedaant00

Copy link
Copy Markdown
Collaborator

Thanks @kocaemre, merged. This is exactly the resolution #130 called for: the docstring no longer claims parity it does not have, it names render_js/scroll_pages as sync-only, and points async users at the right method. Nice touch adding a regression test that asserts both the honest wording is present and the old "same args/returns" phrasing is gone, so it cannot silently creep back. Appreciate the clean contribution.

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.

SoundCloudScraper.scrape_async drops render_js/scroll_pages, so async search can never render JS

2 participants