From 933cb307d90db9546de35b2147d307aa7dd4736e Mon Sep 17 00:00:00 2001 From: Tadashi MATSUO Date: Sun, 26 Sep 2010 23:55:53 +0900 Subject: [PATCH] Fix docstring of `twittering-make-http-request'. * twittering-mode.el: Fix docstring of `twittering-make-http-request'. (twittering-make-http-request): fix docstring. --- ChangeLog | 4 ++++ twittering-mode.el | 12 ++++++++++++ 2 files changed, 16 insertions(+) diff --git a/ChangeLog b/ChangeLog index 56532b87..66daeac3 100644 --- a/ChangeLog +++ b/ChangeLog @@ -43,6 +43,10 @@ (twittering-send-http-request): add two optional arguments for customizing connection method. + * twittering-mode.el: Fix docstring of + `twittering-make-http-request'. + (twittering-make-http-request): fix docstring. + 2010-09-19 Tadashi MATSUO * twittering-mode.el: Fix `twittering-push-uri-onto-kill-ring'. diff --git a/twittering-mode.el b/twittering-mode.el index c24ff10f..5010341d 100644 --- a/twittering-mode.el +++ b/twittering-mode.el @@ -4192,6 +4192,18 @@ Return nil if no connection methods are available with a compromise." (defun twittering-make-http-request (method header-list host port path query-parameters post-body use-ssl) "Returns an alist specifying a HTTP request. +METHOD specifies HTTP method. It must be \"GET\" or \"POST\". +HEADER-LIST is a list of (field-name . field-value) specifying HTTP header +fields. The fields \"Host\" and \"User-Agent\" are automatically filled +if necessary. +HOST specifies the host. +PORT specifies the port. This must be an integer. +PATH specifies the absolute path in URI (without query string). +QUERY-PARAMTERS is a list of pairs (key . value). +POST-BODY specifies the post body sent when METHOD equals to \"POST\". +If POST-BODY is nil, no body is posted. +If USE-SSL is non-nil, the request is performed with SSL. + The result alist includes the following keys, where a key is a symbol. method: HTTP method such as \"GET\" or \"POST\". scheme: the scheme name. \"http\" or \"https\".