improve limit description (#286)

Co-authored-by: Darcy Linde <{[email protected]}>

Author: Darcy-Linde

polygon/rest/quotes.py

@@ -37,7 +37,7 @@ def list_quotes(
         :param timestamp_lte: Timestamp less than or equal to
         :param timestamp_gt: Timestamp greater than
         :param timestamp_gte: Timestamp greater than or equal to
-        :param limit: Limit the number of results returned, default is 10 and max is 50000.
+        :param limit: Limit the number of results returned per-page, default is 10 and max is 50000.
         :param sort: Sort field used for ordering.
         :param order: Order results based on the sort field.
         :param params: Any additional query params.

polygon/rest/reference.py

@@ -101,7 +101,7 @@ def list_tickers(
         :param date: Specify a point in time to retrieve tickers available on that date. Defaults to the most recent available date.
         :param search: Search for terms within the ticker and/or company name.
         :param active: Specify if the tickers returned should be actively traded on the queried date. Default is true.
-        :param limit: Limit the size of the response, default is 100 and max is 1000.
+        :param limit: Limit the size of the response per-page, default is 100 and max is 1000.
         :param sort: The field to sort the results on. Default is ticker. If the search query parameter is present, sort is ignored and results are ordered by relevance.
         :param order: The order to sort the results on. Default is asc (ascending).
         :param params: Any additional query params.
@@ -166,7 +166,7 @@ def list_ticker_news(
 
         :param ticker: Return results that contain this ticker.
         :param published_utc: Return results published on, before, or after this date.
-        :param limit: Limit the number of results returned, default is 10 and max is 1000.
+        :param limit: Limit the number of results returned per-page, default is 10 and max is 1000.
         :param sort: Sort field used for ordering.
         :param order: Order results based on the sort field.
         :param params: Any additional query params.
@@ -243,7 +243,7 @@ def list_splits(
         :param execution_date_gt: Execution date greater than.
         :param execution_date_gte: Execution date greater than or equal to.
         :param reverse_split: Query for reverse stock splits. A split ratio where split_from is greater than split_to represents a reverse split. By default this filter is not used.
-        :param limit: Limit the number of results returned, default is 10 and max is 1000.
+        :param limit: Limit the number of results returned per-page, default is 10 and max is 1000.
         :param sort: Sort field used for ordering.
         :param order: Order results based on the sort field.
         :param params: Any additional query params.
@@ -332,7 +332,7 @@ def list_dividends(
         :param frequency: Query by the number of times per year the dividend is paid out. Possible values are 0 (one-time), 1 (annually), 2 (bi-annually), 4 (quarterly), and 12 (monthly).
         :param cash_amount: Query by the cash amount of the dividend.
         :param dividend_type: Query by the type of dividend. Dividends that have been paid and/or are expected to be paid on consistent schedules are denoted as CD. Special Cash dividends that have been paid that are infrequent or unusual, and/or can not be expected to occur in the future are denoted as SC.
-        :param limit: Limit the number of results returned, default is 10 and max is 1000.
+        :param limit: Limit the number of results returned per-page, default is 10 and max is 1000.
         :param sort: Sort field used for ordering.
         :param order: Order results based on the sort field.
         :param params: Any additional query params.
@@ -369,7 +369,7 @@ def list_conditions(
         :param data_type: Data types that this condition applies to.
         :param id: Filter for conditions with a given ID.
         :param sip: Filter by SIP. If the condition contains a mapping for that SIP, the condition will be returned.
-        :param limit: Limit the number of results returned, default is 10 and max is 1000.
+        :param limit: Limit the number of results returned per-page, default is 10 and max is 1000.
         :param sort: Sort field used for ordering.
         :param order: Order results based on the sort field.
         :param params: Any additional query params.
@@ -476,7 +476,7 @@ def list_options_contracts(
         :param as_of: Specify a point in time for contracts as of this date with format YYYY-MM-DD.
         :param strike_price: Query by strike price of a contract.
         :param expired: Query for expired contracts.
-        :param limit: Limit the number of results returned, default is 10 and max is 1000.
+        :param limit: Limit the number of results returned per-page, default is 10 and max is 1000.
         :param sort: Sort field used for ordering.
         :param order: Order results based on the sort field.
         :param params: Any additional query params.

polygon/rest/trades.py

@@ -29,7 +29,7 @@ def list_trades(
         :param timestamp_lte: Timestamp less than or equal to
         :param timestamp_gt: Timestamp greater than
         :param timestamp_gte: Timestamp greater than or equal to
-        :param limit: Limits the number of base aggregates queried to create the aggregate results. Max 50000 and Default 5000. Read more about how limit is used to calculate aggregate results in our article on Aggregate Data API Improvements.
+        :param limit: Limits the number of base aggregates queried per-page to create the aggregate results. Max 50000 and Default 5000. Read more about how limit is used to calculate aggregate results in our article on Aggregate Data API Improvements.
         :param sort: Sort the results by timestamp. asc will return results in ascending order (oldest at the top), desc will return results in descending order (newest at the top).The end of the aggregate time window.
         :param order: Order results based on the sort field
         :param params: Any additional query params

polygon/rest/vX.py

@@ -51,7 +51,7 @@ def list_stock_financials(
         :param period_of_report_date_gte: period_of_report_date greater than or equal to.
         :param timeframe: Query by timeframe.
         :param include_sources: Whether or not to include the xpath and formula attributes for each financial data point.
-        :param limit: Limit the number of results returned, default is 1 and max is 100.
+        :param limit: Limit the number of results returned per-page, default is 1 and max is 100.
         :param sort: Sort field used for ordering.
         :param order: Order results based on the sort field.
         :param params: Any additional query params