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

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

- Fix docstring typos and stale claims in `Actor`: `MIIGRATING` →
`MIGRATING`, 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.

Author: vdusek

src/apify/_actor.py

@@ -118,7 +118,7 @@ def __init__(
             configuration: The Actor configuration to use. If not provided, a default configuration is created.
             configure_logging: Whether to set up the default logging configuration.
             exit_process: Whether the Actor should call `sys.exit` when the context manager exits.
-                Defaults to True, except in IPython, Pytest, and Scrapy environments.
+                Defaults to True, except in IPython and Scrapy environments.
             exit_code: The exit code the Actor should use when exiting.
             status_message: Final status message to display upon Actor termination.
             event_listeners_timeout: Maximum time to wait for Actor event listeners to complete before exiting.
@@ -912,7 +912,7 @@ async def start(
                 a non-zero status code.
             memory_mbytes: Memory limit for the run, in megabytes. By default, the run uses a memory limit specified
                 in the default run configuration for the Actor.
-            timeout: Optional timeout for the run, in seconds. By default, the run uses timeout specified in
+            timeout: Optional timeout for the run. By default, the run uses timeout specified in
                 the default run configuration for the Actor. Using `inherit` will set timeout of the other Actor
                 to the time remaining from this Actor timeout.
             force_permission_level: Override the Actor's permissions for this run. If not set, the Actor will run
@@ -1019,7 +1019,7 @@ async def call(
                 a non-zero status code.
             memory_mbytes: Memory limit for the run, in megabytes. By default, the run uses a memory limit specified
                 in the default run configuration for the Actor.
-            timeout: Optional timeout for the run, in seconds. By default, the run uses timeout specified in
+            timeout: Optional timeout for the run. By default, the run uses timeout specified in
                 the default run configuration for the Actor. Using `inherit` will set timeout of the other Actor
                 to the time remaining from this Actor timeout.
             force_permission_level: Override the Actor's permissions for this run. If not set, the Actor will run
@@ -1088,17 +1088,16 @@ async def call_task(
         directly rather than an Actor task, please use the `Actor.call`
 
         Args:
-            task_id: The ID of the Actor to be run.
+            task_id: The ID of the Actor task to be run.
             task_input: Overrides the input to pass to the Actor run.
             token: The Apify API token to use for this request (defaults to the `APIFY_TOKEN` environment variable).
-            content_type: The content type of the input.
             build: Specifies the Actor build to run. It can be either a build tag or build number. By default,
                 the run uses the build specified in the default run configuration for the Actor (typically latest).
             restart_on_error: If true, the Task run process will be restarted whenever it exits with
                 a non-zero status code.
             memory_mbytes: Memory limit for the run, in megabytes. By default, the run uses a memory limit specified
                 in the default run configuration for the Actor.
-            timeout: Optional timeout for the run, in seconds. By default, the run uses timeout specified in
+            timeout: Optional timeout for the run. By default, the run uses timeout specified in
                 the default run configuration for the Actor. Using `inherit` will set timeout of the other Actor to the
                 time remaining from this Actor timeout.
             webhooks: Optional webhooks (https://docs.apify.com/webhooks) associated with the Actor run, which can
@@ -1217,7 +1216,7 @@ async def reboot(
             # Call all the listeners for the PERSIST_STATE and MIGRATING events, and wait for them to finish.
             # PERSIST_STATE listeners are called to allow the Actor to persist its state before the reboot.
             # MIGRATING listeners are called to allow the Actor to gracefully stop in-progress tasks before
-            # the reboot. Typically, crawlers are listening for the MIIGRATING event to stop processing new requests.
+            # the reboot. Typically, crawlers are listening for the MIGRATING event to stop processing new requests.
             # We can't just emit the events and wait for all listeners to finish,
             # because this method might be called from an event listener itself, and we would deadlock.
             persist_state_listeners = flatten(

src/apify/_configuration.py

@@ -426,7 +426,7 @@ class Configuration(CrawleeConfiguration):
                 'actor_web_server_port',
                 'apify_container_port',
             ),
-            description='TCP port for the Actor to start an HTTP server on'
+            description='TCP port for the Actor to start an HTTP server on. '
             'This server can be used to receive external messages or expose monitoring and control interfaces',
         ),
     ] = 4321
@@ -458,7 +458,7 @@ class Configuration(CrawleeConfiguration):
         | None,
         Field(
             alias='apify_actor_pricing_info',
-            description='JSON string with prising info of the actor',
+            description='JSON string with pricing info of the actor',
             discriminator='pricing_model',
         ),
         BeforeValidator(_parse_actor_pricing_info),

src/apify/events/_types.py

@@ -20,9 +20,8 @@
 ActorEventTypes = Literal['systemInfo', 'persistState', 'migrating', 'aborting']
 """Event types emitted by the Apify platform during an Actor run.
 
-This is the Apify-specific subset of [`Event`][crawlee.events.Event] — for the full set
-(including framework-level events like `SESSION_RETIRED` or `BROWSER_LAUNCHED`) use
-[`Event`][crawlee.events.Event] from `apify`.
+This is the Apify-specific subset of `Event`. For the full set (including framework-level events
+like `SESSION_RETIRED` or `BROWSER_LAUNCHED`), use `Event` from `apify`.
 """
 
 

src/apify/storage_clients/_apify/_models.py

@@ -102,7 +102,13 @@ class CachedRequest(BaseModel):
     """The expiration time of the lock on the request."""
 
 
+@docs_group('Storage data')
 class ApifyRequestQueueMetadata(RequestQueueMetadata):
+    """Extended request queue metadata model for Apify platform.
+
+    Includes additional Apify-specific fields.
+    """
+
     model_config = ConfigDict(alias_generator=to_camel)
 
     stats: Annotated[

src/apify/storage_clients/_file_system/_storage_client.py

@@ -9,13 +9,15 @@
 
 from ._dataset_client import ApifyFileSystemDatasetClient
 from ._key_value_store_client import ApifyFileSystemKeyValueStoreClient
+from apify._utils import docs_group
 
 if TYPE_CHECKING:
     from collections.abc import Hashable
 
     from crawlee.storage_clients._file_system import FileSystemKeyValueStoreClient
 
 
+@docs_group('Storage clients')
 class ApifyFileSystemStorageClient(FileSystemStorageClient):
     """Apify-specific implementation of the file system storage client.