Commit d1ce47b0 authored by Juanma Barranquero's avatar Juanma Barranquero
Browse files

Typo and docstring fixes.

* url.el (url-do-setup):
* url-dired.el (url-dired-minor-mode):
* url-file.el (url-file-find-possibly-compressed-file):
* url-gw.el (url-gateway-broken-resolution):
* url-handlers.el (url-handler-regexp):
* url-imap.el (url-imap-default-port):
* url-methods.el (url-scheme-get-property): Fix typos in docstrings.

* url-auth.el (url-basic-auth-storage, url-digest-auth):
  Fix typos in docstrings.
  (url-digest-auth-storage, url-register-auth-scheme): Reflow docstrings.

* url-cache.el (url-cache-prepare): Doc fix.
  (url-cache-create-filename-human-readable, url-cache-extract):
  Fix typos in docstrings.

* url-dav.el (url-intersection, url-dav-iso8601-regexp)
  (url-dav-delete-something): Fix typos in docstrings.
  (url-dav-http-success-p, url-dav-file-name-all-completions)
  (url-dav-directory-files, url-dav-file-name-completion): Doc fixes.

* url-http.el (url-http-idle-sentinel): Doc fix.

* url-irc.el (url-irc-default-port): Fix typo in docstring.
  (url-irc-function): Doc fix.

* url-util.el (url-get-url-filename-chars, url-unhex-string):
  Fix typos in docstrings.
  (url-file-extension): Doc fix.

* url-vars.el (url-current-object, url-current-mime-headers)
  (url-privacy-level, url-mail-command, url-mime-language-string):
  Fix typos in docstrings.
  (url-honor-refresh-requests): Reflow docstring.
  (url-using-proxy): Doc fix.
parent 1d344f14
2008-07-02 Juanma Barranquero <lekktu@gmail.com>
* url.el (url-do-setup):
* url-dired.el (url-dired-minor-mode):
* url-file.el (url-file-find-possibly-compressed-file):
* url-gw.el (url-gateway-broken-resolution):
* url-handlers.el (url-handler-regexp):
* url-imap.el (url-imap-default-port):
* url-methods.el (url-scheme-get-property): Fix typos in docstrings.
* url-auth.el (url-basic-auth-storage, url-digest-auth):
Fix typos in docstrings.
(url-digest-auth-storage, url-register-auth-scheme): Reflow docstrings.
* url-cache.el (url-cache-prepare): Doc fix.
(url-cache-create-filename-human-readable, url-cache-extract):
Fix typos in docstrings.
* url-dav.el (url-intersection, url-dav-iso8601-regexp)
(url-dav-delete-something): Fix typos in docstrings.
(url-dav-http-success-p, url-dav-file-name-all-completions)
(url-dav-directory-files, url-dav-file-name-completion): Doc fixes.
* url-http.el (url-http-idle-sentinel): Doc fix.
* url-irc.el (url-irc-default-port): Fix typo in docstring.
(url-irc-function): Doc fix.
* url-util.el (url-get-url-filename-chars, url-unhex-string):
Fix typos in docstrings.
(url-file-extension): Doc fix.
* url-vars.el (url-current-object, url-current-mime-headers)
(url-privacy-level, url-mail-command, url-mime-language-string):
Fix typos in docstrings.
(url-honor-refresh-requests): Reflow docstring.
(url-using-proxy): Doc fix.
2008-06-22 Dan Nicolaescu <dann@ics.uci.edu>
* vc-dav.el: Move to the parent directory to be together with the
......
......@@ -51,7 +51,7 @@
Must be a symbol pointing to another variable that will actually store
the information. The value of this variable is an assoc list of assoc
lists. The first assoc list is keyed by the server name. The cdr of
this is an assoc list based on the 'directory' specified by the url we
this is an assoc list based on the 'directory' specified by the URL we
are looking up.")
(defun url-basic-auth (url &optional prompt overwrite realm args)
......@@ -134,10 +134,10 @@ instead of the filename inheritance method."
;;; This is very secure
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
(defvar url-digest-auth-storage nil
"Where usernames and passwords are stored. Its value is an assoc list of
assoc lists. The first assoc list is keyed by the server name. The cdr of
this is an assoc list based on the 'directory' specified by the url we are
looking up.")
"Where usernames and passwords are stored.
Its value is an assoc list of assoc lists. The first assoc list is
keyed by the server name. The cdr of this is an assoc list based
on the 'directory' specified by the url we are looking up.")
(defun url-digest-auth-create-key (username password realm method uri)
"Create a key for digest authentication method"
......@@ -151,7 +151,7 @@ looking up.")
(defun url-digest-auth (url &optional prompt overwrite realm args)
"Get the username/password for the specified URL.
If optional argument PROMPT is non-nil, ask for the username/password
to use for the url and its descendants. If optional third argument
to use for the URL and its descendants. If optional third argument
OVERWRITE is non-nil, overwrite the old username/password pair if it
is found in the assoc list. If REALM is specified, use that as the realm
instead of hostname:portnum."
......@@ -308,11 +308,11 @@ PROMPT is boolean - specifies whether to ask the user for a username/password
(defun url-register-auth-scheme (type &optional function rating)
"Register an HTTP authentication method.
TYPE is a string or symbol specifying the name of the method. This
should be the same thing you expect to get returned in an Authenticate
header in HTTP/1.0 - it will be downcased.
FUNCTION is the function to call to get the authorization information. This
defaults to `url-?-auth', where ? is TYPE
TYPE is a string or symbol specifying the name of the method.
This should be the same thing you expect to get returned in
an Authenticate header in HTTP/1.0 - it will be downcased.
FUNCTION is the function to call to get the authorization information.
This defaults to `url-?-auth', where ? is TYPE.
RATING a rating between 1 and 10 of the strength of the authentication.
This is used when asking for the best authentication for a specific
URL. The item with the highest rating is returned."
......
......@@ -46,8 +46,8 @@ Creates any necessary parent directories, deleting any non-directory files
that would stop this. Returns nil if parent directories can not be
created. If FILE already exists as a non-directory, it changes
permissions of FILE or deletes FILE to make it possible to write a new
version of FILE. Returns nil if this can not be done. Returns nil if
FILE already exists as a directory. Otherwise, returns t, indicating that
version of FILE. Returns nil if this can not be done, or if FILE already
exists as a directory. Otherwise, returns t, indicating that
FILE can be created or overwritten."
(cond
((url-cache-file-writable-p file)
......@@ -82,7 +82,7 @@ FILE can be created or overwritten."
(nth 5 attribs)))) ; Can get last mod-time
(defun url-cache-create-filename-human-readable (url)
"Return a filename in the local cache for URL"
"Return a filename in the local cache for URL."
(if url
(let* ((url (if (vectorp url) (url-recreate-url url) url))
(urlobj (url-generic-parse-url url))
......@@ -178,7 +178,7 @@ Very fast if you have an `md5' primitive function, suitably fast otherwise."
;;;###autoload
(defun url-cache-extract (fnam)
"Extract FNAM from the local disk cache"
"Extract FNAM from the local disk cache."
(erase-buffer)
(insert-file-contents-literally fnam))
......
......@@ -38,7 +38,7 @@
"List of supported DAV versions.")
(defun url-intersection (l1 l2)
"Return a list of the elements occuring in both of the lists L1 and L2."
"Return a list of the elements occurring in both of the lists L1 and L2."
(if (null l2)
l2
(let (result)
......@@ -100,7 +100,7 @@
(list (concat "^" full-date)
(concat "T" partial-time)
(concat "Z" time-numoffset)))
"List of regular expressions matching iso8601 dates.
"List of regular expressions matching ISO 8601 dates.
1st regular expression matches the date.
2nd regular expression matches the time.
3rd regular expression matches the (optional) timezone specification.")
......@@ -472,7 +472,7 @@ names (ie: DAV:resourcetype)."
depth nil namespaces))
(defmacro url-dav-http-success-p (status)
"Return whether PROPERTIES was the result of a successful DAV request."
"Return whether STATUS was the result of a successful DAV request."
`(= (/ (or ,status 500) 100) 2))
......@@ -714,8 +714,7 @@ OBJ may be a buffer or a string."
(defmacro url-dav-delete-something (url lock-token &rest error-checking)
"Delete URL completely, with no sanity checking whatsoever. DO NOT USE.
This is defined as a macro that will not be visible from compiled files.
Use with care, and even then think three times.
"
Use with care, and even then think three times."
`(progn
,@error-checking
(url-dav-request ,url "DELETE" nil nil -1
......@@ -769,7 +768,7 @@ files in the collection as well."
nil)
(defun url-dav-directory-files (url &optional full match nosort files-only)
"Return a list of names of files in DIRECTORY.
"Return a list of names of files in URL.
There are three optional arguments:
If FULL is non-nil, return absolute file names. Otherwise return names
that are relative to the specified directory.
......@@ -889,16 +888,16 @@ If NOSORT is non-nil, the list is not sorted--its order is unpredictable.
t))
(defun url-dav-file-name-all-completions (file url)
"Return a list of all completions of file name FILE in directory DIRECTORY.
These are all file names in directory DIRECTORY which begin with FILE."
"Return a list of all completions of file name FILE in URL.
These are all file names in URL which begin with FILE."
(url-dav-directory-files url nil (concat "^" file ".*")))
(defun url-dav-file-name-completion (file url)
"Complete file name FILE in directory DIRECTORY.
Returns the longest string
common to all file names in DIRECTORY that start with FILE.
"Complete file name FILE in URL.
Returns the longest string common to all file names in URL
that start with FILE.
If there is only one and FILE matches it exactly, returns t.
Returns nil if DIR contains no name starting with FILE."
Returns nil if URL contains no name starting with FILE."
(let ((matches (url-dav-file-name-all-completions file url))
(result nil))
(cond
......
......@@ -32,7 +32,7 @@
"Keymap used when browsing directories.")
(defvar url-dired-minor-mode nil
"Whether we are in url-dired-minor-mode")
"Whether we are in url-dired-minor-mode.")
(make-variable-buffer-local 'url-dired-minor-mode)
......
......@@ -39,7 +39,7 @@
This tries the common compression extensions, because things like
ange-ftp and efs are not quite smart enough to realize when a server
can do automatic decompression for them, and won't find 'foo' if
'foo.gz' exists, even though the ftp server would happily serve it up
'foo.gz' exists, even though the FTP server would happily serve it up
to them."
(let ((scratch nil)
(compressed-extensions '("" ".gz" ".z" ".Z" ".bz2"))
......
......@@ -98,7 +98,7 @@ This list will be executed as a command after logging in via telnet."
"*Whether to use nslookup to resolve hostnames.
This should be used when your version of Emacs cannot correctly use DNS,
but your machine can. This usually happens if you are running a statically
linked Emacs under SunOS 4.x"
linked Emacs under SunOS 4.x."
:type 'boolean
:group 'url-gateway)
......
......@@ -93,7 +93,7 @@
(defvar url-handler-regexp
"\\`\\(https?\\|ftp\\|file\\|nfs\\)://"
"*A regular expression for matching URLs handled by file-name-handler-alist.
"*A regular expression for matching URLs handled by `file-name-handler-alist'.
Some valid URL protocols just do not make sense to visit interactively
\(about, data, info, irc, mailto, etc\). This regular expression
avoids conflicts with local files that look like URLs \(Gnus is
......
......@@ -153,7 +153,7 @@ request.")
(defun url-http-create-request (&optional ref-url)
"Create an HTTP request for `url-http-target-url', referred to by REF-URL."
(declare (special proxy-info
(declare (special proxy-info
url-http-method url-http-data
url-http-extra-headers))
(let* ((extra-headers)
......@@ -323,10 +323,10 @@ This allows us to use `mail-fetch-field', etc."
;; find strongest supported auth
(dolist (this-auth auths)
(setq this-auth (url-eat-trailing-space
(url-strip-leading-spaces
(setq this-auth (url-eat-trailing-space
(url-strip-leading-spaces
this-auth)))
(let* ((this-type
(let* ((this-type
(if (string-match "[ \t]" this-auth)
(downcase (substring this-auth 0 (match-beginning 0)))
(downcase this-auth)))
......@@ -418,7 +418,7 @@ should be shown to the user."
;; "Connection: keep-alive" header.
;; In HTTP 1.1 (and greater), keep the connection unless there is a
;; "Connection: close" header
(cond
(cond
((string= url-http-response-version "1.0")
(unless (and connection
(string= (downcase connection) "keep-alive"))
......@@ -800,7 +800,7 @@ should be shown to the user."
;; These unfortunately cannot be macros... please ignore them!
(defun url-http-idle-sentinel (proc why)
"Remove this (now defunct) process PROC from the list of open connections."
"Remove (now defunct) process PROC from the list of open connections."
(maphash (lambda (key val)
(if (memq proc val)
(puthash key (delq proc val) url-http-open-connections)))
......
......@@ -35,7 +35,7 @@
(require 'nnimap)
(require 'mm-util)
(defconst url-imap-default-port 143 "Default IMAP port")
(defconst url-imap-default-port 143 "Default IMAP port.")
(defun url-imap-open-host (host port user pass)
;; xxx use user and password
......@@ -70,7 +70,7 @@
;; fetch message part
;; xxx handle partial fetches
(insert "Content-type: message/rfc822\n\n")
(nnimap-request-article (cdr (assoc "UID" (url-attributes url)))
(nnimap-request-article (cdr (assoc "UID" (url-attributes url)))
mailbox host (current-buffer)))
(t
;; xxx list messages in mailbox (start gnus?)
......
......@@ -29,11 +29,11 @@
(require 'url-vars)
(require 'url-parse)
(defconst url-irc-default-port 6667 "Default port for IRC connections")
(defconst url-irc-default-port 6667 "Default port for IRC connections.")
(defcustom url-irc-function 'url-irc-rcirc
"*Function to actually open an IRC connection.
Should be a function that takes several arguments:
The function should take the following arguments:
HOST - the hostname of the IRC server to contact
PORT - the port number of the IRC server to contact
CHANNEL - What channel on the server to visit right away (can be nil)
......
......@@ -110,7 +110,7 @@
(message "Using a proxy for %s..." scheme)))))
(defun url-scheme-get-property (scheme property)
"Get property of a URL SCHEME.
"Get PROPERTY of a URL SCHEME.
Will automatically try to load a backend from url-SCHEME.el if
it has not already been loaded."
(setq scheme (downcase scheme))
......
......@@ -301,7 +301,7 @@ Will not do anything if `url-show-status' is nil."
;;;###autoload
(defun url-unhex-string (str &optional allow-newlines)
"Remove %XX embedded spaces, etc in a url.
"Remove %XX embedded spaces, etc in a URL.
If optional second argument ALLOW-NEWLINES is non-nil, then allow the
decoding of carriage returns and line feeds in the string, which is normally
forbidden in URL encoding."
......@@ -342,7 +342,7 @@ character in the utf-8 string, those found in `url-unreserved-chars'
are left as-is, all others are represented as a three-character
string: \"%\" followed by two lowercase hex digits."
;; To go faster and avoid a lot of consing, we could do:
;;
;;
;; (defconst url-hexify-table
;; (let ((map (make-vector 256 nil)))
;; (dotimes (byte 256) (aset map byte
......@@ -364,8 +364,8 @@ string: \"%\" followed by two lowercase hex digits."
;;;###autoload
(defun url-file-extension (fname &optional x)
"Return the filename extension of FNAME.
If optional variable X is t,
then return the basename of the file with the extension stripped off."
If optional argument X is t, then return the basename
of the file with the extension stripped off."
(if (and fname
(setq fname (url-file-nondirectory fname))
(string-match "\\.[^./]+$" fname))
......@@ -429,7 +429,7 @@ This uses `url-current-object', set locally to the buffer."
(eval-and-compile
(defvar url-get-url-filename-chars "-%.?@a-zA-Z0-9()_/:~=&"
"Valid characters in a URL")
"Valid characters in a URL.")
)
(defun url-get-url-at-point (&optional pt)
......
......@@ -55,10 +55,10 @@
(defvar url-current-object nil
"A parsed representation of the current url.")
"A parsed representation of the current URL.")
(defvar url-current-mime-headers nil
"A parsed representation of the MIME headers for the current url.")
"A parsed representation of the MIME headers for the current URL.")
(mapc 'make-variable-buffer-local
'(
......@@ -72,8 +72,7 @@
These are done at the request of the document author or the server via
the `Refresh' header in an HTTP response. If nil, no refresh
requests will be honored. If t, all refresh requests will be honored.
If non-nil and not t, the user will be asked for each refresh
request."
If non-nil and not t, the user will be asked for each refresh request."
:type '(choice (const :tag "off" nil)
(const :tag "on" t)
(const :tag "ask" 'ask))
......@@ -118,17 +117,17 @@ This variable controls how much of this information is sent.
This should a symbol or a list.
Valid values if a symbol are:
none -- Send all information
low -- Don't send the last location
high -- Don't send the email address or last location
paranoid -- Don't send anything
none -- send all information
low -- don't send the last location
high -- don't send the email address or last location
paranoid -- don't send anything
If a list, this should be a list of symbols of what NOT to send.
Valid symbols are:
email -- the email address
os -- the operating system info
lastloc -- the last location
agent -- Do not send the User-Agent string
agent -- do not send the User-Agent string
cookie -- never accept HTTP cookies
Samples:
......@@ -174,7 +173,7 @@ variable."
:group 'url-mime)
(defcustom url-mail-command 'compose-mail
"*This function will be called whenever url needs to send mail.
"*This function will be called whenever URL needs to send mail.
It should enter a mail-mode-like buffer in the current window.
The commands `mail-to' and `mail-subject' should still work in this
buffer, and it should use `mail-header-separator' if possible."
......@@ -259,7 +258,7 @@ given priority 1 and the rest are given priority 0.5.")
"*String to send in the Accept-language: field in HTTP requests.
Specifies the preferred language when servers can serve documents in
several languages. Use RFC 1766 abbreviations, e.g.@: `en' for
several languages. Use RFC 1766 abbreviations, e.g.: `en' for
English, `de' for German. A comma-separated specifies descending
order of preference. The ordering can be made explicit using `q'
factors defined by HTTP, e.g. `de,en-gb;q=0.8,en;q=0.7'. `*' means
......@@ -304,7 +303,7 @@ a terminal with a slow modem."
(defvar url-using-proxy nil
"Either nil or the fully qualified proxy URL in use, e.g.
http://www.domain.com/")
http://www.example.com/")
(defcustom url-news-server nil
"*The default news server from which to get newsgroups/articles.
......
......@@ -56,7 +56,7 @@
:group 'url)
(defun url-do-setup ()
"Setup the url package.
"Setup the URL package.
This is to avoid conflict with user settings if URL is dumped with
Emacs."
(unless url-setup-done
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment