curl.h: name all public function parameters#10036
Closed
ryandesign wants to merge 1 commit intocurl:masterfrom
Closed
curl.h: name all public function parameters#10036ryandesign wants to merge 1 commit intocurl:masterfrom
ryandesign wants to merge 1 commit intocurl:masterfrom
Conversation
Most public function parameters already have names; this adds those that were missing.
bagder
approved these changes
Dec 6, 2022
Member
|
Thanks! |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Most public function parameters already have names; this adds those that were missing.
I took the parameter names from where the functions were defined in the C sources. In some cases this does not match the documentation. For example, in lib/slist.c (and, with this PR, in curl.h) the second parameter of
curl_slist_appendis calleddatawhile in the documentation it's calledstring.My motivation for making these changes arose when I wrote a script to parse the curl headers in part to get the public function parameter names and I noticed a few functions didn't have them. Do you have any objections to adding these?