diff options
| author | Rémi Verschelde <rverschelde@gmail.com> | 2019-10-23 06:50:41 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-10-23 06:50:41 +0200 |
| commit | 29990d0b1efb264618ef334e573d5f62ece1d0b2 (patch) | |
| tree | 6f216fa47bf24e0ff73d8c768d2707da23914eb1 | |
| parent | 72dfa67dd3508f20592959d306e8f2ef159eea5f (diff) | |
| parent | 04d3146b755d081566424f42eea11c8303a2f859 (diff) | |
Merge pull request #32994 from Calinou/http-document-body-length-caveats
Mention body length getter caveats in HTTPClient and HTTPRequest
| -rw-r--r-- | doc/classes/HTTPClient.xml | 3 | ||||
| -rw-r--r-- | doc/classes/HTTPRequest.xml | 1 |
2 files changed, 3 insertions, 1 deletions
diff --git a/doc/classes/HTTPClient.xml b/doc/classes/HTTPClient.xml index 1a2d5cab81..52e4b94051 100644 --- a/doc/classes/HTTPClient.xml +++ b/doc/classes/HTTPClient.xml @@ -44,6 +44,7 @@ </return> <description> Returns the response's body length. + [b]Note:[/b] Some Web servers may not send a body length. In this case, the value returned will be [code]-1[/code]. If using chunked transfer encoding, the body length will also be [code]-1[/code]. </description> </method> <method name="get_response_code" qualifiers="const"> @@ -175,7 +176,7 @@ <argument index="0" name="bytes" type="int"> </argument> <description> - Sets the size of the buffer used and maximum bytes to read per iteration. see [method read_response_body_chunk] + Sets the size of the buffer used and maximum bytes to read per iteration. See [method read_response_body_chunk]. </description> </method> </methods> diff --git a/doc/classes/HTTPRequest.xml b/doc/classes/HTTPRequest.xml index 53ee0b6132..3a73d44a01 100644 --- a/doc/classes/HTTPRequest.xml +++ b/doc/classes/HTTPRequest.xml @@ -23,6 +23,7 @@ </return> <description> Returns the response body length. + [b]Note:[/b] Some Web servers may not send a body length. In this case, the value returned will be [code]-1[/code]. If using chunked transfer encoding, the body length will also be [code]-1[/code]. </description> </method> <method name="get_downloaded_bytes" qualifiers="const"> |