Fix links for list/iter warning

Author: vshlapakov

scrapinghub/client/activity.py

@@ -11,8 +11,8 @@ class Activity(_Proxy):
     instance to get a :class:`~scrapinghub.client.activity.Activity` instance.
     See :attr:`~scrapinghub.client.projects.Project.activity` attribute.
 
-    Please note that ``list()`` method can use a lot of memory and for a large
-    amount of activities it's recommended to iterate through it via ``iter()``
+    Please note that :meth:`list` method can use a lot of memory and for a large
+    amount of activities it's recommended to iterate through it via :meth:`iter`
     method (all params and available filters are same for both methods).
 
     Usage:

scrapinghub/client/collections.py

@@ -160,10 +160,10 @@ def list(self, key=None, prefix=None, prefixcount=None, startts=None,
              endts=None, requests_params=None, **params):
         """Convenient shortcut to list iter results.
 
-        Please note that ``list()`` method can use a lot of memory and for a
-        large amount of elements it's recommended to iterate through it via
-        ``iter()`` method (all params and available filters are same for both
-        methods).
+        Please note that :meth:`list` method can use a lot of memory and for a
+        large amount of logs it's recommended to iterate through it
+        via :meth:`iter` method (all params and available filters are same for
+        both methods).
 
         :param key: a string key or a list of keys to filter with.
         :param prefix: a string prefix to filter items.

scrapinghub/client/items.py

@@ -10,9 +10,10 @@ class Items(_Proxy):
     e to get a :class:`Items` instance.
     See :attr:`~scrapinghub.client.jobs.Job.items` attribute.
 
-    Please note that ``list()`` method can use a lot of memory and for a large
-    amount of items it's recommended to iterate through it via ``iter()`` method
-    (all params and available filters are same for both methods).
+    Please note that :meth:`list` method can use a lot of memory and for
+    a large amount of logs it's recommended to iterate through it via
+    :meth:`iter` method (all params and available filters are same for
+    both methods).
 
     Usage:
 

scrapinghub/client/jobs.py

@@ -167,8 +167,8 @@ def list(self, count=None, start=None, spider=None, state=None,
         :return: list of dictionaries of jobs summary for a given filter params.
         :rtype: :class:`list[dict]`
 
-        Please note that list() method can use a lot of memory and for a large
-        amount of jobs it's recommended to iterate through it via iter()
+        Please note that :meth:`list` can use a lot of memory and for a large
+        amount of logs it's recommended to iterate through it via :meth:`iter`
         method (all params and available filters are same for both methods).
         """
         # FIXME we double-check the params here, is there a better way?

scrapinghub/client/logs.py

@@ -12,9 +12,9 @@ class Logs(_Proxy):
     to get a :class:`Logs` instance. See :attr:`~scrapinghub.client.jobs.Job.logs`
     attribute.
 
-    Please note that ``list()`` method can use a lot of memory and for a large
-    amount of logs it's recommended to iterate through it via ``iter()`` method
-    (all params and available filters are same for both methods).
+    Please note that :meth:`list` method can use a lot of memory and for a
+    large amount of logs it's recommended to iterate through it via :meth:`iter`
+    method (all params and available filters are same for both methods).
 
     Usage:
 

scrapinghub/client/requests.py

@@ -10,9 +10,10 @@ class Requests(_Proxy):
     to get a :class:`Requests` instance.
     See :attr:`~scrapinghub.client.jobs.Job.requests` attribute.
 
-    Please note that ``list()`` method can use a lot of memory and for a large
-    amount of requests it's recommended to iterate through it via ``iter()``
-    method (all params and available filters are same for both methods).
+    Please note that :meth:`list` method can use a lot of memory and for
+    a large amount of logs it's recommended to iterate through it via
+    :meth:`iter` method (all params and available filters are same for
+    both methods).
 
     Usage:
 

scrapinghub/client/samples.py

@@ -10,9 +10,10 @@ class Samples(_Proxy):
     to get a :class:`Samples` instance.
     See :attr:`~scrapinghub.client.jobs.Job.samples` attribute.
 
-    Please note that ``list()`` method can use a lot of memory and for a large
-    amount of samples it's recommended to iterate through it via ``iter()``
-    method (all params and available filters are same for both methods).
+    Please note that :meth:`list` method can use a lot of memory and for
+    a large amount of logs it's recommended to iterate through it via
+    :meth:`iter` method (all params and available filters are same for
+    both methods).
 
     Usage:
 

scrapinghub/client/utils.py

@@ -145,9 +145,9 @@ def _modify_iter_params(self, params):
     def list(self, *args, **kwargs):
         """Convenient shortcut to list iter results.
 
-        Please note that ``list()`` method can use a lot of memory and for a
+        Please note that :meth:`list` method can use a lot of memory and for a
         large amount of elements it's recommended to iterate through it via
-        ``iter()`` method (all params and available filters are same for both
+        :meth:`iter` method (all params and available filters are same for both
         methods).
         """
         return list(self.iter(*args, **kwargs))