[elpa] externals/plz-media-type 08abc1e28a 15/26: Improve plz-media-type-request doc string

[ELPA Syncer]

branch: externals/plz-media-type
commit 08abc1e28ad1bb3a423521530b1ca3bd3fb871c1
Author: Roman Scherer <roman@burningswell.com>
Commit: Roman Scherer <roman@burningswell.com>

    Improve plz-media-type-request doc string
---
 plz-media-type.el | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/plz-media-type.el b/plz-media-type.el
index d71e3a034d..0b39b8915a 100644
--- a/plz-media-type.el
+++ b/plz-media-type.el
@@ -540,6 +540,17 @@ parsing the HTTP response body with the
      (then 'sync)
      (timeout plz-timeout))
   "Request METHOD from URL with curl.
+
+This function works in a similar way as the `plz' function, with
+the additional functionality of handling streaming and
+non-streaming media types with the :as (media-types MEDIA-TYPES)
+option.  Setting a process :filter by the user is not supported.
+Instead this function will always install its own process filter
+that will process the response until the HTTP headers arrived.
+Once the headers arrived it will hand over control to a media
+type based on the content type header of the response.  The media
+type is responsible for processing the HTTP body.
+
 Return the curl process object or, for a synchronous request, the
 selected result.