From 7dd525959e6b62bd6ebc0351fb69ecb3d964ab9b Mon Sep 17 00:00:00 2001
From: Matias Holte <matias.holte@cognite.com>
Date: Tue, 7 Nov 2023 14:22:49 +0100
Subject: [PATCH] update subscription docs (#1472)

---
 .../client/_api/datapoints_subscriptions.py   | 21 ++++++++++++-------
 1 file changed, 14 insertions(+), 7 deletions(-)

diff --git a/cognite/client/_api/datapoints_subscriptions.py b/cognite/client/_api/datapoints_subscriptions.py
index 6d3044dbf7..c6073d89e1 100644
--- a/cognite/client/_api/datapoints_subscriptions.py
+++ b/cognite/client/_api/datapoints_subscriptions.py
@@ -51,7 +51,7 @@ def create(self, subscription: DataPointSubscriptionCreate) -> DatapointSubscrip
                 >>> from cognite.client.data_classes import DataPointSubscriptionCreate
                 >>> c = CogniteClient()
                 >>> sub = DataPointSubscriptionCreate("mySubscription", partition_count=1, time_series_ids=["myFistTimeSeries", "mySecondTimeSeries"], name="My subscription")
-                >>> created = c.time_series.subscriptions.create()
+                >>> created = c.time_series.subscriptions.create(sub)
 
             Create a filter defined subscription for all numeric time series:
 
@@ -88,7 +88,7 @@ def delete(self, external_id: str | Sequence[str], ignore_unknown_ids: bool = Fa
 
                 >>> from cognite.client import CogniteClient
                 >>> c = CogniteClient()
-                >>> batch = c.time_series.subscriptions.delete("my_subscription")
+                >>> c.time_series.subscriptions.delete("my_subscription")
         """
         self._warning.warn()
 
@@ -114,7 +114,7 @@ def retrieve(self, external_id: str, ignore_unknown_ids: bool = False) -> Datapo
 
                 >>> from cognite.client import CogniteClient
                 >>> c = CogniteClient()
-                >>> batch = c.time_series.subscriptions.retrieve("my_subscription")
+                >>> res = c.time_series.subscriptions.retrieve("my_subscription")
         """
         self._warning.warn()
 
@@ -151,6 +151,8 @@ def list_member_time_series(self, external_id: str, limit: int | None = DEFAULT_
                 >>> members = c.time_series.subscriptions.list_member_time_series("my_subscription")
                 >>> timeseries_external_ids = members.as_external_ids()
         """
+        self._warning.warn()
+
         return self._list(
             method="GET",
             limit=limit,
@@ -188,7 +190,7 @@ def update(self, update: DataPointSubscriptionUpdate) -> DatapointSubscription:
                 >>> from cognite.client import CogniteClient
                 >>> from cognite.client.data_classes import DataPointSubscriptionUpdate
                 >>> c = CogniteClient()
-                >>> update = DataPointSubscriptionUpdate("my_subscription").time_series_ids.add("MyNewTimeSeriesExternalId")
+                >>> update = DataPointSubscriptionUpdate("my_subscription").time_series_ids.add(["MyNewTimeSeriesExternalId"])
                 >>> updated = c.time_series.subscriptions.update(update)
         """
         self._warning.warn()
@@ -236,14 +238,19 @@ def iterate_data(
                 >>> for batch in c.time_series.subscriptions.iterate_data("my_subscription"):
                 ...     print(f"Added {len(batch.subscription_changes.added)} timeseries")
                 ...     print(f"Removed {len(batch.subscription_changes.removed)} timeseries")
-                ...     print(f"Changed data in {len(batch.updates)} timeseries")
+                ...     print(f"Changed timeseries data in {len(batch.updates)} updates")
+                ...     if not batch.has_next:
+                ...         break
 
-            Iterate over all changes in the subscripted timeseries the last 3 days:
+            Iterate continuously over all changes to the subscription newer than 3 days:
 
+                >>> import time
                 >>> for batch in c.time_series.subscriptions.iterate_data("my_subscription", "3d-ago"):
                 ...     print(f"Added {len(batch.subscription_changes.added)} timeseries")
                 ...     print(f"Removed {len(batch.subscription_changes.removed)} timeseries")
-                ...     print(f"Changed data in {len(batch.updates)} timeseries")
+                ...     print(f"Changed timeseries data in {len(batch.updates)} updates")
+                ...     if not batch.has_next:
+                ...         time.sleep(1)
         """
         self._warning.warn()