Commit 1433a222 authored by Christopher Zaborsky's avatar Christopher Zaborsky
Browse files

Doc fix.

parent d367fa71
......@@ -733,8 +733,9 @@ are given, use those instead of the ones saved."
(setq count (1- count))))
(defun vi-scroll-down-window (count)
"Scrolls down window COUNT lines. If COUNT is nil (actually, non-integer),
scrolls default amount. The given COUNT is remembered for future scrollings."
"Scrolls down window COUNT lines.
If COUNT is nil (actually, non-integer), scrolls default amount.
The given COUNT is remembered for future scrollings."
(interactive "P")
(if (integerp count)
(setq vi-scroll-amount count))
......@@ -774,8 +775,9 @@ scrolls default amount. The given COUNT is remembered for future scrollings."
(back-to-indentation))
(defun vi-scroll-up-window (count)
"Scrolls up window COUNT lines. If COUNT is nil (actually, non-integer),
scrolls default amount. The given COUNT is remembered for future scrollings."
"Scrolls up window COUNT lines.
If COUNT is nil (actually, non-integer), scrolls default amount.
The given COUNT is remembered for future scrollings."
(interactive "P")
(if (integerp count)
(setq vi-scroll-amount count))
......@@ -798,8 +800,8 @@ Possible perfix-arg cases are NIL, INTEGER, (NIL . CHAR) or (INTEGER . CHAR)."
(t (setq prefix-arg (cons (car arg) char))))))
(defun vi-goto-mark (mark-char &optional line-flag)
"Go to marked position or line (if line-flag is given). Goto mark '@' means
jump into and pop the top mark on the mark ring."
"Go to marked position or line (if line-flag is given).
Goto mark '@' means jump into and pop the top mark on the mark ring."
(cond ((char-equal mark-char last-command-char) ; `` or ''
(exchange-point-and-mark) (if line-flag (back-to-indentation)))
((char-equal mark-char ?@) ; jump and pop mark
......@@ -1070,14 +1072,14 @@ MOTION-COMMAND with ARG.
(vi-set-last-change-command 'vi-yank-op 'next-line arg)))
(defun vi-string-end-with-nl-p (string)
"See if STRING ends with a newline char. Used in checking whether the yanked
text should be put back as lines or not."
"See if STRING ends with a newline char.
Used in checking whether the yanked text should be put back as lines or not."
(= (aref string (1- (length string))) ?\n))
(defun vi-put-before (arg &optional after-p)
"Put yanked (in vi sense) text back before/above cursor. If a numeric prefix
value (currently it should be >1) is given, put back text as lines.
If the optional after-p is given, put after/below the cursor."
"Put yanked (in vi sense) text back before/above cursor.
If a numeric prefix value (currently it should be >1) is given, put back
text as lines. If the optional after-p is given, put after/below the cursor."
(interactive "P")
(let ((reg (vi-prefix-char-value arg)) put-text)
(if (and reg (or (< reg ?1) (> reg ?9)) (null (get-register reg)))
......@@ -1107,7 +1109,8 @@ If the optional after-p is given, put after/below the cursor."
(vi-put-before arg t))
(defun vi-shell-op (motion-command arg &optional shell-command)
"Perform shell command (as filter) on range specified by MOTION-COMMAND
"Perform shell command (as filter).
Performs command on range specified by MOTION-COMMAND
with ARG. If SHELL-COMMAND is not given, ask for one from minibuffer.
If char argument is given, it directs the output to a *temp* buffer."
(let* ((range (vi-effective-range motion-command arg))
......@@ -1157,8 +1160,8 @@ SPECIAL FEATURE: char argument can be used to specify shift amount(1-9)."
(cdr (assq char vi-mark-alist)))
(defun vi-set-mark (char)
"Set contents of vi mark register named CHAR to current point. '@' is the
special anonymous mark register."
"Set contents of vi mark register named CHAR to current point.
'@' is the special anonymous mark register."
(interactive "c")
(if (char-equal char ?@)
(set-mark-command nil)
......@@ -1219,12 +1222,12 @@ special anonymous mark register."
(vi-ding)))
(defun vi-set-last-change-command (fun &rest args)
"Set (FUN . ARGS) as the last-change-command."
"Set (FUN . ARGS) as the `last-change-command'."
(setq vi-last-change-command (cons fun args)))
(defun vi-redo-last-change-command (count &optional command)
"Redo last change command COUNT times. If the optional COMMAND is given,
it is used instead of the current last-change-command."
it is used instead of the current `last-change-command'."
(interactive "p")
(if (null command)
(setq command vi-last-change-command))
......@@ -1241,7 +1244,8 @@ it is used instead of the current last-change-command."
(vi-set-last-change-command 'delete-char count t))
(defun vi-transpose-objects (arg unit)
"Transpose objects, the following char specifies unit of objects to be
"Transpose objects.
The following char specifies unit of objects to be
transposed -- \"c\" for chars, \"l\" for lines, \"w\" for words, \"s\" for
sexp, \"p\" for paragraph.
For the use of the prefix-arg, refer to individual functions called."
......@@ -1296,9 +1300,9 @@ For the use of the prefix-arg, refer to individual functions called."
(ding))))
(defun vi-name-last-change-or-macro (arg char)
"Give name to the last change command or just defined kbd macro. If prefix
ARG is given, name last macro, otherwise name last change command. The
following CHAR will be the name for the command or macro."
"Give name to the last change command or just defined kbd macro.
If prefix ARG is given, name last macro, otherwise name last change command.
The following CHAR will be the name for the command or macro."
(interactive "P\nc")
(if arg
(name-last-kbd-macro (intern (char-to-string char)))
......@@ -1397,8 +1401,8 @@ r(egion), s(tring), w(ord) ]."
(command-execute cmd nil)))))
(defun vi-quote-words (arg char)
"Quote ARG words from the word point is on with the pattern specified by the
CHAR. Currently, CHAR could be [,{,(,\",',`,<,*, etc."
"Quote ARG words from the word point is on with pattern specified by CHAR.
Currently, CHAR could be [,{,(,\",',`,<,*, etc."
(interactive "*p\nc")
(while (not (string-match "[[({<\"'`*]" (char-to-string char)))
(message "Enter any of [,{,(,<,\",',`,* as quoting character.")
......@@ -1416,8 +1420,8 @@ CHAR. Currently, CHAR could be [,{,(,\",',`,<,*, etc."
(insert char))
(defun vi-locate-def ()
"Locate definition in current file for the name before the point. It assumes
a `(def..' always starts at the beginning of a line."
"Locate definition in current file for the name before the point.
It assumes a `(def..' always starts at the beginning of a line."
(interactive)
(let (name)
(save-excursion
......@@ -1437,7 +1441,7 @@ a `(def..' always starts at the beginning of a line."
(defun vi-split-open-line (arg)
"Insert a newline and leave point before it.
With arg, inserts that many newlines."
With ARG, inserts that many newlines."
(interactive "*p")
(vi-goto-insert-state 1
(list (function (lambda (arg)
......
......@@ -2924,7 +2924,8 @@ a token has type \(command, address, end-mark\) and value."
(shell))
(defun ex-substitute (&optional repeat r-flag)
"ex substitute. if REPEAT use previous reg-exp which is ex-reg-exp or
"ex substitute.
If REPEAT use previous reg-exp which is ex-reg-exp or
vip-s-string"
(let (pat repl (opt-g nil) (opt-c nil) (matched-pos nil))
(if repeat (setq ex-token nil) (vip-get-ex-pat))
......
......@@ -48,11 +48,11 @@
while looking for the initial password.")
(defvar telnet-initial-count -50
"Initial value of telnet-count. Should be set to the negative of the
"Initial value of `telnet-count'. Should be set to the negative of the
number of terminal writes telnet will make setting up the host connection.")
(defvar telnet-maximum-count 4
"Maximum value telnet-count can have.
"Maximum value `telnet-count' can have.
After this many passes, we stop looking for initial setup data.
Should be set to the number of terminal writes telnet will make
rejecting one login and prompting for the again for a username and password.")
......@@ -165,8 +165,8 @@ Normally input is edited in Emacs and sent a line at a time."
(setq telnet-count telnet-initial-count)))
(defun telnet-mode ()
"This mode is for use during telnet from a buffer to another
host. It has most of the same commands as comint-mode.
"This mode is for telnetting from a buffer to another host.
It has most of the same commands as comint-mode.
There is a variable ``telnet-interrupt-string'' which is the character
sent to try to stop execution of a job on the remote host.
Data is sent to the remote host when RET is typed.
......
......@@ -824,8 +824,8 @@ line LINE of the window, or centered if LINE is nil."
(defun tex-print (&optional alt)
"Print the .dvi file made by \\[tex-region], \\[tex-buffer] or \\[tex-file].
Runs the shell command defined by tex-dvi-print-command. If prefix argument
is provided, use the alternative command, tex-alt-dvi-print-command."
Runs the shell command defined by `tex-dvi-print-command'. If prefix argument
is provided, use the alternative command, `tex-alt-dvi-print-command'."
(interactive "P")
(let ((print-file-name-dvi (tex-append tex-print-file ".dvi"))
test-name)
......@@ -863,7 +863,7 @@ so normally SUFFIX starts with one."
(defun tex-show-print-queue ()
"Show the print queue that \\[tex-print] put your job on.
Runs the shell command defined by tex-show-queue-command."
Runs the shell command defined by `tex-show-queue-command'."
(interactive)
(if (tex-shell-running)
(tex-kill-job)
......
......@@ -317,14 +317,14 @@ to jump to the corresponding spot in the Texinfo file."
"*Command used by texinfo-texindex to sort unsorted index files.")
(defun texinfo-tex-region (beg end)
"Run tex on the current region. A temporary file (tex-zap-file) is
written in directory tex-directory, and tex is run in that directory.
The first line of the file is copied to the temporary file; and
if the buffer has a header, it is written to the temporary file before
the region itself. The buffer's header is all lines between the
strings defined by tex-start-of-header and tex-end-of-header
inclusive. The header must start in the first 100 lines. The value
of tex-trailer is appended to the temporary file after the region."
"Run tex on the current region.
A temporary file (`tex-zap-file') is written in directory `tex-directory', and
tex is run in that directory. The first line of the file is copied to the
temporary file; and if the buffer has a header, it is written to the
temporary file before the region itself. The buffer's header is all lines
between the strings defined by `tex-start-of-header' and `tex-end-of-header'
inclusive. The header must start in the first 100 lines. The value of
tex-trailer is appended to the temporary file after the region."
(interactive "r")
(if (get-buffer "*tex-shell*")
(tex-kill-job)
......@@ -398,7 +398,7 @@ See \\[texinfo-tex-region] for more information."
(defun texinfo-texindex ()
"Run texindex on unsorted index files.
The index files are made by \\[texinfo-tex-region] or \\[texinfo-tex-buffer].
Runs the shell command defined by texinfo-texindex-command."
Runs the shell command defined by `texinfo-texindex-command'."
(interactive)
(send-string "tex-shell"
(concat texinfo-texindex-command
......@@ -407,7 +407,7 @@ Runs the shell command defined by texinfo-texindex-command."
(defun texinfo-tex-print ()
"Print .dvi file made by \\[texinfo-tex-region] or \\[texinfo-tex-buffer].
Runs the shell command defined by tex-dvi-print-command."
Runs the shell command defined by `tex-dvi-print-command'."
(interactive)
(send-string "tex-shell"
(concat tex-dvi-print-command
......
......@@ -87,7 +87,7 @@ the call to the function. If REPEAT is nil, call it just once."
(setq timer-process nil timer-alist nil))))
(defun cancel-timer (function)
"Cancel all events scheduled by ``run-at-time'' which would run FUNCTION."
"Cancel all events scheduled by `run-at-time' which would run FUNCTION."
(interactive "aCancel function: ")
(let ((alist timer-alist))
(while alist
......
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