curl-multi-exec.xml Change the function purpose #3944
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'm not sure I'm offering a better description, perhaps a formulation like `Run the connections of handles contained in the given cURL multi handle` would be better, or some similar. I was just a little confused by the words `sub-connections` (the explanation of which is not given, although it is clear that we are talking about the connections of descriptors contained in the multi-descriptor), and the `current` word... Current in relation to what?
| @@ -3,9 +3,9 @@ | |||
| <refentry xml:id="function.curl-multi-exec" xmlns="http://docbook.org/ns/docbook"> | |||
| <refnamediv> | |||
| <refname>curl_multi_exec</refname> | |||
| <refpurpose>Run the sub-connections of the current cURL handle</refpurpose> | |||
| <refpurpose>Run the connections of handles of a set of cURL handles</refpurpose> | |||
There was a problem hiding this comment.
What does "running a connection" mean? Shouldn't it say more or less the same as the description below?
There was a problem hiding this comment.
You're right, the word "connections" is confusing. Probably, it should have been formulated like this:
Performs transfers on all easy handles added in cURL multi handle
English is not my native language, and again I'm not sure if I'm offering the best wording. I only know that the current function assignment is even worse ;)
Run the sub-connections of the current cURL handle
There was a problem hiding this comment.
Yes, you could do that but I feel it would be better to keep it the same as below.
Suggested change
| <refpurpose>Run the connections of handles of a set of cURL handles</refpurpose> | |
| <refpurpose>Processes each of the handles in the stack</refpurpose> |
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'm not sure I'm offering a better description, perhaps a formulation like
Run the connections of handles contained in the given cURL multi handle [asynchronously]would be better, or some similar. I was just a little confused by the wordssub-connections(the explanation of which is not given, although it is clear that we are talking about the connections of descriptors contained in the multi-descriptor), and thecurrentword... current in relation to what, and multipleconnectionsfor athe current cURL handle(it sounds like a normal handle contains a lot of connections).And I also don't know if we should add a paragraph saying that the multi handle starts many connections at once, which can improve the performance of application