Skip to content

Commit

Permalink
Fix docstring of `twittering-make-http-request'.
Browse files Browse the repository at this point in the history
* twittering-mode.el: Fix docstring of
`twittering-make-http-request'.
(twittering-make-http-request): fix docstring.
  • Loading branch information
cvmat committed Sep 26, 2010
1 parent 65ee771 commit 933cb30
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 0 deletions.
4 changes: 4 additions & 0 deletions ChangeLog
Expand Up @@ -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 <tad@mymail.twin.jp>

* twittering-mode.el: Fix `twittering-push-uri-onto-kill-ring'.
Expand Down
12 changes: 12 additions & 0 deletions twittering-mode.el
Expand Up @@ -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\".
Expand Down

0 comments on commit 933cb30

Please sign in to comment.