Skip to content

Commit 8ba32fa

Browse files
authored
Added the page and page_size param's in docstring for get_everything(). (#67)
1 parent 9e55789 commit 8ba32fa

1 file changed

Lines changed: 8 additions & 0 deletions

File tree

newsapi/newsapi_client.py

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -229,6 +229,14 @@ def get_everything( # noqa: C901
229229
See :data:`newsapi.const.sort_method` for the set of allowed values.
230230
:type sort_by: str or None
231231
232+
:param page: The number of results to return per page (request).
233+
20 is the default, 100 is the maximum.
234+
:type page: int or None
235+
236+
:param page_size: Use this to page through the results if the total results found is
237+
greater than the page size.
238+
:type page_size: int or None
239+
232240
:return: JSON response as nested Python dictionary.
233241
:rtype: dict
234242
:raises NewsAPIException: If the ``"status"`` value of the response is ``"error"`` rather than ``"ok"``.

0 commit comments

Comments
 (0)