* lisp/net/quickurl.el: Documentation typo fixes.

This commit is contained in:
Deniz Dogan 2011-08-25 07:43:57 +02:00
parent b2948976fc
commit a2ebe600c9
2 changed files with 14 additions and 10 deletions

View file

@ -1,3 +1,7 @@
2011-08-25 Deniz Dogan <deniz@dogan.se>
* net/quickurl.el: Documentation typo fixes.
2011-08-25 Chong Yidong <cyd@stupidchicken.com> 2011-08-25 Chong Yidong <cyd@stupidchicken.com>
* window.el (bury-buffer, quit-window): Use bury-buffer-internal. * window.el (bury-buffer, quit-window): Use bury-buffer-internal.

View file

@ -1,4 +1,4 @@
;;; quickurl.el --- insert an URL based on text at point in buffer ;;; quickurl.el --- insert a URL based on text at point in buffer
;; Copyright (C) 1999-2011 Free Software Foundation, Inc. ;; Copyright (C) 1999-2011 Free Software Foundation, Inc.
@ -24,7 +24,7 @@
;;; Commentary: ;;; Commentary:
;; ;;
;; This package provides a simple method of inserting an URL based on the ;; This package provides a simple method of inserting a URL based on the
;; text at point in the current buffer. This is part of an on-going effort ;; text at point in the current buffer. This is part of an on-going effort
;; to increase the information I provide people while reducing the ammount ;; to increase the information I provide people while reducing the ammount
;; of typing I need to do. No-doubt there are undiscovered Emacs packages ;; of typing I need to do. No-doubt there are undiscovered Emacs packages
@ -90,7 +90,7 @@
;; Customize options. ;; Customize options.
(defgroup quickurl nil (defgroup quickurl nil
"Insert an URL based on text at point in buffer." "Insert a URL based on text at point in buffer."
:version "21.1" :version "21.1"
:group 'abbrev :group 'abbrev
:prefix "quickurl-") :prefix "quickurl-")
@ -194,14 +194,14 @@ in your ~/.emacs (after loading/requiring quickurl).")
(defvar quickurl-list-last-buffer nil (defvar quickurl-list-last-buffer nil
"`current-buffer' when `quickurl-list' was called.") "`current-buffer' when `quickurl-list' was called.")
;; Functions for working with an URL entry. ;; Functions for working with a URL entry.
(defun quickurl-url-commented-p (url) (defun quickurl-url-commented-p (url)
"Does the URL have a comment?" "Does the URL have a comment?"
(listp (cdr url))) (listp (cdr url)))
(defun quickurl-make-url (keyword url &optional comment) (defun quickurl-make-url (keyword url &optional comment)
"Create an URL from KEYWORD, URL and (optionaly) COMMENT." "Create a URL from KEYWORD, URL and (optionaly) COMMENT."
(if (and comment (not (zerop (length comment)))) (if (and comment (not (zerop (length comment))))
(list keyword url comment) (list keyword url comment)
(cons keyword url))) (cons keyword url)))
@ -230,7 +230,7 @@ Note that this function is a setfable place."
(setf (cdr ,url) ,store))) (setf (cdr ,url) ,store)))
(defun quickurl-url-comment (url) (defun quickurl-url-comment (url)
"Get the comment from an URL. "Get the comment from a URL.
If the URL has no comment an empty string is returned. Also note that this If the URL has no comment an empty string is returned. Also note that this
function is a setfable place." function is a setfable place."
@ -304,7 +304,7 @@ Also display a `message' saying what the URL was unless SILENT is non-nil."
;;;###autoload ;;;###autoload
(defun* quickurl (&optional lookup) (defun* quickurl (&optional lookup)
"Insert an URL based on LOOKUP. "Insert a URL based on LOOKUP.
If not supplied LOOKUP is taken to be the word at point in the current If not supplied LOOKUP is taken to be the word at point in the current
buffer, this default action can be modifed via buffer, this default action can be modifed via
@ -323,7 +323,7 @@ buffer, this default action can be modifed via
;;;###autoload ;;;###autoload
(defun quickurl-ask (lookup) (defun quickurl-ask (lookup)
"Insert an URL, with `completing-read' prompt, based on LOOKUP." "Insert a URL, with `completing-read' prompt, based on LOOKUP."
(interactive (interactive
(list (list
(progn (progn
@ -335,7 +335,7 @@ buffer, this default action can be modifed via
(quickurl-insert url)))) (quickurl-insert url))))
(defun quickurl-grab-url () (defun quickurl-grab-url ()
"Attempt to grab a word/url pair from point in the current buffer. "Attempt to grab a word/URL pair from point in the current buffer.
Point should be somewhere on the URL and the word is taken to be the thing Point should be somewhere on the URL and the word is taken to be the thing
that is returned from calling `quickurl-grab-lookup-function' once a that is returned from calling `quickurl-grab-lookup-function' once a
@ -369,7 +369,7 @@ It is assumed that the URL is either \"unguarded\" or is wrapped inside an
(defun quickurl-add-url (word url comment) (defun quickurl-add-url (word url comment)
"Allow the user to interactively add a new URL associated with WORD. "Allow the user to interactively add a new URL associated with WORD.
See `quickurl-grab-url' for details on how the default word/url combination See `quickurl-grab-url' for details on how the default word/URL combination
is decided." is decided."
(interactive (let ((word-url (quickurl-grab-url))) (interactive (let ((word-url (quickurl-grab-url)))
(list (read-string "Word: " (quickurl-url-keyword word-url)) (list (read-string "Word: " (quickurl-url-keyword word-url))