Clarify language around "max" CLI flags #38
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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.
binaryaaron
approved these changes
Jun 29, 2018
There was a problem hiding this comment.
I'm tagging @EmilySheehan here as we discussed changing results-per-call and max-results of these to not be overloaded with the search API at all, but I like adding the explicit notice here. Thanks!
binaryaaron
suggested changes
Jul 3, 2018
There was a problem hiding this comment.
Whoops, I made a mistake - these changes should go into the examples/base_readme.rst file, as this readme is generated from there. @jrmontag, do you mind putting this verbiage into that file?
|
Thanks for the clarification, and no problem. I'll make those changes and add another commit. |
|
@binaryaaron I've reverted that change and move the text into the correct file. Let me know if you'd like to see any other changes. |
|
@jrmontag @binaryaaron could you guys follow up on this? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I've attempted to be more explicit and consistent with the language used to explain and differentiate between the two CLI flags:
--max-resultsand--results-per-call. These are understandably a bit confusing and #37 reminded me that we could try to be more specific.