Correction of a comment in /docs/examples/url2file.c. #4745
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
The comment was confusing and suggested that setting CURLOPT_NOPROGRESS to 0L would both enable and disable debug output at the same time, like a Schrödinger's cat of CURLOPTs.
bagder
reviewed
Dec 20, 2019
docs/examples/url2file.c
Outdated
| @@ -57,7 +57,7 @@ int main(int argc, char *argv[]) | |||
| /* Switch on full protocol/debug output while testing */ | |||
| curl_easy_setopt(curl_handle, CURLOPT_VERBOSE, 1L); | |||
|
|
|||
| /* disable progress meter, set to 0L to enable and disable debug output */ | |||
| /* disable progress meter, set to 0L to enable debug output */ | |||
There was a problem hiding this comment.
Is it even "debug output" ? Maybe just shorten and simplify it to:
/* disable progress meter */There was a problem hiding this comment.
I feel the same way regarding the debug output reference.
I think debug output was reffering to the progress meter.
I think the information of what 0L does, reversing the action,
might actually be good to still have. As a user, I want to know
what happens if I do things differently and be informed about
the alternatives that exists.
But I can submit another patch with the shortened:
/* disable progress meter */
if you'd prefer.
There was a problem hiding this comment.
... or
/* disable progress meter, set to 0L to enable it */
bagder
approved these changes
Dec 20, 2019
|
Thanks! |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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 stumbled upon the url2file.c example and i noticed this
comment:
/* disable progress meter, set to 0L to enable and disable debug output */I think it would look better if it read:
/* disable progress meter, set to 0L to enable debug output */I think the comment is confusing, as it is today, because it suggests
that two things happen at the same time here, setting it to 0L both
enables and disables debug output at the same time, like the Schrödinger's
cat of CURLOPTs.
Then I learn that the reason CURLOPT_NOPROGRESS is set to 1L in the following
line is to disable output and that setting it to 0L is reversing this action.
This is why I am doing this pull request.