Skip to content

docs: Fix docstring typos, add missing docs groups, and document platform purge()#982

Open
vdusek wants to merge 2 commits into
masterfrom
docs/cleanup-docstrings
Open

docs: Fix docstring typos, add missing docs groups, and document platform purge()#982
vdusek wants to merge 2 commits into
masterfrom
docs/cleanup-docstrings

Conversation

@vdusek

@vdusek vdusek commented Jun 12, 2026

Copy link
Copy Markdown
Contributor

Documentation-only portion of the v4 major-release cleanup.

  • Fix docstring typos and stale claims in Actor: MIIGRATINGMIGRATING, drop the nonexistent call_task content_type argument, drop the "in seconds" note on timeout (the parameter is a timedelta), correct the exit_process default note, and fix the task_id description.
  • Fix Configuration docstrings: "prising" → "pricing", and the concatenated web_server_port description.
  • Replace mkdocs-style cross-references in events/_types.py with plain backticks.
  • Add @docs_group plus a docstring to ApifyRequestQueueMetadata, and @docs_group to ApifyFileSystemStorageClient.
  • Document in the v4 upgrading guide that platform storages raise NotImplementedError on purge() (use drop() instead). Local file-system storages are unaffected.

@vdusek vdusek added adhoc Ad-hoc unplanned task added during the sprint. t-tooling Issues with this label are in the ownership of the tooling team. labels Jun 12, 2026
@vdusek vdusek self-assigned this Jun 12, 2026
@github-actions github-actions Bot added this to the 142nd sprint - Tooling team milestone Jun 12, 2026
@codecov

codecov Bot commented Jun 12, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 89.91%. Comparing base (0daca28) to head (653f080).
⚠️ Report is 1 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #982   +/-   ##
=======================================
  Coverage   89.90%   89.91%           
=======================================
  Files          49       49           
  Lines        3091     3094    +3     
=======================================
+ Hits         2779     2782    +3     
  Misses        312      312           
Flag Coverage Δ
e2e 35.97% <100.00%> (+0.06%) ⬆️
integration 56.91% <100.00%> (+0.04%) ⬆️
unit 78.76% <100.00%> (+0.02%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@vdusek vdusek requested a review from Pijukatel June 12, 2026 16:52
@vdusek vdusek marked this pull request as ready for review June 12, 2026 16:53
@vdusek vdusek requested a review from szaganek as a code owner June 12, 2026 16:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

adhoc Ad-hoc unplanned task added during the sprint. t-tooling Issues with this label are in the ownership of the tooling team.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants