Skip to content

Commit da5afeb

Browse files
jrmontagAaron Gonzales
authored andcommitted
Clarify language around "max" CLI flags (#38)
* Clarify language around "max" CLI flags I've attempted to be more explicit and consistent with the language used to explain and differentiate between the two CLI flags: ``--max-results`` and ``--results-per-call``. These are understandably a bit confusing and #37 reminded me that we could try to be more specific. * Revert "Clarify language around "max" CLI flags" This reverts commit 53e76cb. * Relocate CLI text to the proper .rst file.
1 parent 57be425 commit da5afeb

File tree

1 file changed

+14
-6
lines changed

1 file changed

+14
-6
lines changed

examples/base_readme.rst

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -53,12 +53,20 @@ access to Tweets. When you use ``pip`` to install this package,
5353
``search_tweets.py`` is installed globally. The file is located in the
5454
``tools/`` directory for those who want to run it locally.
5555

56-
Note that the ``--results-per-call`` flag specifies an argument to the API
57-
( ``maxResults``, results returned per CALL), not as a hard max to number of
58-
results returned from this program. The argument ``--max-results`` defines the
59-
maximum number of results to return from a given call. All examples assume that
60-
your credentials are set up correctly in the default location
61-
- ``.twitter_keys.yaml`` or in environment variables.
56+
Note that the ``--results-per-call`` flag specifies the maximum number of
57+
results to return per CALL, or, equivalently, per pagination request. This
58+
does not affect the maximum number of results returned from running the
59+
program. The argument ``--max-results`` determines the maximum number of
60+
results to return from a run of the program (cumulative over any
61+
pagination).
62+
63+
The astute reader will observe that the ``--results-per-call`` setting
64+
is later assigned to a payload key called ``maxResults`` under the hood.
65+
The authors acknowledge that this is somewhat confusing, but hope that
66+
the CLI flags are more intuitive in their naming.
67+
68+
All examples assume that your credentials are set up correctly in the
69+
default location (``.twitter_keys.yaml``) or in environment variables.
6270

6371

6472
**Stream json results to stdout without saving**

0 commit comments

Comments
 (0)