Document SensitiveParameter attribute in callbacks
Open
Beginner friendly
Nobody has claimed this yet.
enhancement
- Dominant language
- XML
- Stars
- 596
- Forks
- 890
- Avg merge
- 1d 15h
- Merged PRs (30d)
- 55
Description
Affected page
https://www.php.net/manual/en/curl.constants.php
Current issue
E.g. CURLOPT_SSH_HOSTKEYFUNCTION:
The callback must have the following signature:
function callback(
resource $curlHandle,
int $keyType,
string $key,
int $keyLength
): int
Suggested improvement
I think it would be better if it said #[\SensitiveParameter]string $key.
Additional context (optional)
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the curl.constants.php page and locate the CURLOPT_SSH_HOSTKEYFUNCTION callback signature. Update the $key parameter documentation to show the SensitiveParameter attribute, then verify that the published signature matches the suggested improvement and retains the string type.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- php
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Quiet
- Clarity
- Clearly specified
- Newbie friendliness
- 85/100