Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Various minor docs fixes #543

Merged
merged 7 commits into from
Sep 17, 2021
Merged

Conversation

jrfnl
Copy link
Member

@jrfnl jrfnl commented Sep 17, 2021

Docs: remove stray unicode character from docs

Ssl: remove incorrect @throws tag

This method does not throw.

Docs: add missing @return tags

Docs: add missing method docblock

Headers::getIterator() fix up comment in docblock

... which was clearly unfinished.

Documentation: fix minor grammar error

Documentation: fix references to Curl resources

The PHP Curl extension worked with a Curl resource in PHP 4/5/7. As of PHP 8.0, curl_init() returns an instance of CurlHandle instead of a resource.

This updates the documentation to indicate that either a resource or CurlHandle instance can be expected in certain places in the code base (and that both are supported).

Ref: https://www.php.net/manual/en/migration80.incompatible.php#migration80.incompatible.resource2object

This method does not throw.
... which was clearly unfinished.
The PHP Curl extension worked with a Curl resource in PHP 4/5/7. As of PHP 8.0, `curl_init()` returns an instance of `CurlHandle` instead of a resource.

This updates the documentation to indicate that either a `resource` or `CurlHandle` instance can be expected in certain places in the code base (and that both are supported).

Ref: https://www.php.net/manual/en/migration80.incompatible.php#migration80.incompatible.resource2object
@jrfnl jrfnl added this to the 2.0.0 milestone Sep 17, 2021
@schlessera schlessera merged commit a0aa2a8 into develop Sep 17, 2021
@schlessera schlessera deleted the feature/various-minor-docs-fixes branch September 17, 2021 09:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants